mirror of
https://github.com/LukeHagar/crossws.git
synced 2025-12-07 12:27:46 +00:00
docs: migrate to unjs-docs structure v2 (#13)
* docs: migrate to unjs-docs structure v2 * update to stable
This commit is contained in:
0
docs/.gitignore → docs/.docs/.gitignore
vendored
0
docs/.gitignore → docs/.docs/.gitignore
vendored
|
Before Width: | Height: | Size: 2.7 KiB After Width: | Height: | Size: 2.7 KiB |
@@ -1,2 +0,0 @@
|
|||||||
shamefully-hoist=true
|
|
||||||
ignore-workspace-root-check=true
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# Runtime Adapters
|
# Adapters
|
||||||
|
|
||||||
CrossWS allows integrating your WebSocket hooks with different runtimes and platforms using built-in adapters. Each runtime has a specific method of integrating WebSocket. Once integrated, will work consistently even if you change the runtime.
|
CrossWS allows integrating your WebSocket hooks with different runtimes and platforms using built-in adapters. Each runtime has a specific method of integrating WebSocket. Once integrated, will work consistently even if you change the runtime.
|
||||||
|
|
||||||
BIN
docs/bun.lockb
Executable file
BIN
docs/bun.lockb
Executable file
Binary file not shown.
@@ -1,45 +0,0 @@
|
|||||||
title: "CrossWS"
|
|
||||||
description: "Cross-platform WebSocket Servers for Node.js, Deno, Bun and Cloudflare Workers."
|
|
||||||
navigation: false
|
|
||||||
hero:
|
|
||||||
title: "[CrossWS]{.text-primary} :br [Cross-platform WebSockets]{.text-4xl}"
|
|
||||||
description: "One code for Node.js, Deno, Bun and Cloudflare Workers"
|
|
||||||
orientation: horizontal
|
|
||||||
links:
|
|
||||||
- label: "Get Started"
|
|
||||||
icon: "i-heroicons-rocket-launch"
|
|
||||||
to: "/getting-started"
|
|
||||||
size: lg
|
|
||||||
- label: "Play Online"
|
|
||||||
icon: "i-heroicons-play"
|
|
||||||
to: "https://stackblitz.com/github/unjs/crossws/tree/main/examples/h3?file=app.ts"
|
|
||||||
size: lg
|
|
||||||
- label: "Contribute on GitHub"
|
|
||||||
icon: "i-simple-icons-github"
|
|
||||||
color: "white"
|
|
||||||
to: "https://github.com/unjs/crossws"
|
|
||||||
target: "_blank"
|
|
||||||
size: lg
|
|
||||||
# code:
|
|
||||||
features:
|
|
||||||
title: "WebSockets, supercharged."
|
|
||||||
links:
|
|
||||||
- label: "Get started"
|
|
||||||
icon: "i-heroicons-rocket-launch"
|
|
||||||
trailingIcon: "i-heroicons-arrow-right-20-solid"
|
|
||||||
color: "gray"
|
|
||||||
to: "/getting-started"
|
|
||||||
size: lg
|
|
||||||
items:
|
|
||||||
- title: "Runtime-Agnostic"
|
|
||||||
description: "Seamlessly integrates with Bun, Deno, Cloudflare Workrs and Node.js (ws or uWebSockets.js)"
|
|
||||||
icon: ""
|
|
||||||
- title: "Made for Performance"
|
|
||||||
description: "High-performance server hooks, avoiding heavy per-connection events API"
|
|
||||||
icon: ""
|
|
||||||
- title: "Lightweight"
|
|
||||||
description: "Zero Dependency with bundled ws for Node.js support. Extremely lightweight and tree-shakable packaging with ESM and CJS support."
|
|
||||||
icon: ""
|
|
||||||
- title: "Developer-friendly"
|
|
||||||
description: "Typed Hooks API and human friednly logging support."
|
|
||||||
icon: ""
|
|
||||||
36
docs/docs.config.json
Normal file
36
docs/docs.config.json
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://raw.githubusercontent.com/unjs/docs/main/schema/config.json",
|
||||||
|
"name": "CrossWS",
|
||||||
|
"description": "Cross-platform WebSocket Servers for Node.js, Deno, Bun and Cloudflare Workers.",
|
||||||
|
"shortDescription": "Cross-platform WebSockets.",
|
||||||
|
"github": "unjs/crossws",
|
||||||
|
"themeColor": "#f7932a",
|
||||||
|
"landing": {
|
||||||
|
"heroDescription": "One code for Node.js, Deno, Bun and Cloudflare Workers!",
|
||||||
|
"heroLinks": {
|
||||||
|
"playOnline": {
|
||||||
|
"label": "Play Online",
|
||||||
|
"icon": "i-heroicons-play",
|
||||||
|
"to": "https://stackblitz.com/github/unjs/crossws/tree/main/examples/h3?file=app.ts"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"features": [
|
||||||
|
{
|
||||||
|
"title": "Runtime Agnostic",
|
||||||
|
"description": "Seamlessly integrates with Bun, Deno, Cloudflare Workrs and Node.js (ws or uWebSockets.js)"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "Made for Performance",
|
||||||
|
"description": "High-performance server hooks API designed to avoid creating callbacks per client but once."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "Lightweight",
|
||||||
|
"description": "Zero Dependency with bundled ws for Node.js support. Extremely lightweight and tree-shakable packaging with ESM and CJS support."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "Developer Friendly",
|
||||||
|
"description": "Typed Hooks API and human friednly logging support."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
import { defineDocsConfig } from "unjs-docs/config";
|
|
||||||
|
|
||||||
export default defineDocsConfig({
|
|
||||||
name: "CrossWS",
|
|
||||||
description:
|
|
||||||
"Cross-platform WebSocket Servers for Node.js, Deno, Bun and Cloudflare Workers.",
|
|
||||||
github: "unjs/crossws",
|
|
||||||
themeColor: "#f7932a",
|
|
||||||
});
|
|
||||||
@@ -6,6 +6,6 @@
|
|||||||
"build": "unjs-docs build"
|
"build": "unjs-docs build"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"unjs-docs": "latest"
|
"unjs-docs": "^0.2.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
10042
docs/pnpm-lock.yaml
generated
10042
docs/pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1 +0,0 @@
|
|||||||
# empty
|
|
||||||
Reference in New Issue
Block a user