Files
crossws/docs/.config/docs.yaml
Pooya Parsa 2e49cc34c0 docs: update
2024-08-07 13:01:08 +02:00

22 lines
1.2 KiB
YAML

# yaml-language-server: $schema=https://unpkg.com/undocs/schema/config.json
name: crossws
shortDescription: Unified WebSocket Servers
description: elegant, typed, and simple toolkit to implement cross-platform WebSocket servers.
github: unjs/crossws
landing:
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: 🧩 Pluggable
description: Seamlessly integrates with [Bun](https://crossws.unjs.io/adapters/bun), [Cloudflare Workers](https://crossws.unjs.io/adapters/cloudflare), [Deno](https://crossws.unjs.io/adapters/deno) and [Node.js](https://crossws.unjs.io/adapters/node) and any compatible web framework.
- title: 📦 Lightweight
description: Extremely lightweight and tree-shakable conditional ESM exports. Prebundled with [ws](https://github.com/websockets/ws) for Node.js support.
- title: 🚀 Made for Performance
description: High-performance and simple hooks API, without per-connection callback creation.
- title: 🌟 Developer Friendly
description: Typed hooks API and developer-friendly object inspection.