Skip to content

Commit

Permalink
docs: added other frontmatters (#831)
Browse files Browse the repository at this point in the history
  • Loading branch information
pluvrt authored Dec 12, 2024
1 parent 3e6db3b commit 8e419cc
Show file tree
Hide file tree
Showing 21 changed files with 105 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/@pluv__client/api_reference.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "API Reference"
description: "@pluv/client API Reference"
---

# API Reference

## createClient
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__client/client_vs_server_events.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Client vs Server Events"
description: "Understanding the difference between client and server custom events, and when to prefer which"
---

# Client vs Server Events

In pluv.io, you can define type-safe custom events both on the client and server. Both client and server event procedures represent a message that a user has sent to be transformed before being emitted to connected peers. If a procedure does not exist to capture a received message, that message will be forwarded as-is to the next receiver of the message. i.e. if a client procedure does not exist, the message is forwarded to the server procedure. If that does not exist, then the message is forwarded to connected peers.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__client/create_client.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Create Client"
description: "Create a framework-agnostic type-safe pluv.io client to add real-time to any app"
---

# Create Client

Generally, it is recommended to use framework-specific bindings for your particular UI framework such as [@pluv/react](https://www.npmjs.com/package/@pluv/react). However, if your selected framework isn't yet supported, you can create a framework-agnostic pluv.io client to add automatic type-safe real-time to any app.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__client/create_rooms.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Create Rooms"
description: "Learn how to create and connect to rooms with @pluv/client"
---

# Creating Rooms

Rooms are the channels that WebSockets can enter and leave (i.e. connect and disconnect). Events emitted by sockets in a room will be broadcasted only to other sockets within the same room.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__client/define_events.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Define Events"
description: "Define events in pluv.io by simply defining event procedures as JavaScript functions"
---

# Define Events

In pluv.io, you can define custom events with an input validation schema and a function, and have them be automatically type-safe without having to manage your own types.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__io/api_reference.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "API Reference"
description: "@pluv/io API reference"
---

# API Reference

## createIO
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__io/authorization.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Authorization"
description: "Learn how to add custom authorization to rooms in @pluv/io"
---

# Authorization

pluv.io uses JWTs to authorize access to rooms on a new connection. To generate a JWT, you will need to setup an authentication endpoint to determine if the user should have access to the room.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__io/cloudflare_workers.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Cloudflare Workers"
description: "Build real-time applications with pluv.io on Cloudflare Workers"
---

# Cloudflare Workers

pluv.io supports building real-time APIs with [Cloudflare Workers](https://workers.cloudflare.com/) through their [Durable Objects API](https://developers.cloudflare.com/workers/runtime-apis/durable-objects/). You can define your handler and your DurableObject manually if you need more control, but if you'd like to get started quickly, check out [createPluvHandler](/docs/io/cloudflare-workers#createPluvHandler).
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__io/define_events.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Define Events"
description: "Define events in pluv.io by simply defining event procedures as JavaScript functions"
---

# Define Events

In pluv.io, you can define custom events with an input validation schema and a function, and have them be automatically type-safe without having to manage your own types.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__io/loading_storage.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Loading Storage"
description: "Listen to storage and room changes, and initialize rooms with saved storage"
---

# Loading Storage

Listen to when a room is deleted so that when the same room is re-created, users can resume from the same storage as where they left off.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__io/nodejs.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Node.js"
description: "Build real-time applications with pluv.io on Node.js"
---

# Node.js

pluv.io supports building real-time APIs with [Node.js](https://nodejs.org/). You can define your handler and websocket server manually if you need more control, but if you'd like to get started quicky, check out [createPluvHandler](/docs/io/node.js#createPluvHandler).
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__io/pubsub.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "PubSub"
description: "Add a PubSub to pluv.io to horizontally scale your real-time API"
---

# PubSub

> **Note**: Currently PubSub's are supported for Node.js only.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__react/api_reference.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "API Reference"
description: "@pluv/react API Reference"
---

# API Reference

## createClient
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__react/create_bundle.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Create Bundle"
description: "Learn how to create a frontend client and React.js bundle for pluv.io"
---

# Create Bundle

pluv.io ships [@pluv/react](https://npmjs.com/package/@pluv/react) to leverage [@pluv/client](https://npmjs.com/package/@pluv/client) in a type-safe and React.js way.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__react/create_rooms.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Create Rooms"
description: "Learn how to create and connect to rooms with @pluv/react"
---

# Create Rooms

Rooms are the channels that WebSockets can enter and leave (i.e. connect and disconnect). Events emitted by sockets in a room will be broadcasted only to other sockets within the same room.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__react/custom_events.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Custom Events"
description: "Learn how to use custom type-safe events with @pluv/react"
---

# Custom Events

Define custom events on your backend `PluvServer` instance. Then send and receive custom websocket events in a type-safe way with `@pluv/react`.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__react/history.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "History"
description: "How to undo and redo on @pluv/react"
---

# History

`@pluv/react` comes with hooks to manipulate history that are built on top of the CRDT library you are using.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__react/presence.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Presence"
description: "Learn how to apply awareness and presence to your real-time applications with @pluv/react"
---

# Presence

Presence is a per-connection state that allows users to track what other users are doing in the same room. Presence can be used to represent movement, selections, and characteristics of a user, and can be really important to building collaborative experiences.
Expand Down
5 changes: 5 additions & 0 deletions docs/@pluv__react/yjs_storage.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Yjs Storage"
description: "Learn how to use Yjs storage with @pluv/react"
---

# Yjs Storage

pluv.io supports conflict-free replicated data-types (CRDT) storage with [yjs](https://yjs.dev). This allows modifying shared data between multiple users, and also leveraging some libraries within the yjs ecosystem such as [rich-text-editor bindings](https://docs.yjs.dev/ecosystem/editor-bindings).
Expand Down
5 changes: 5 additions & 0 deletions docs/ecosystem.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Ecosystem"
description: "Packages to use alongside pluv"
---

# Ecosystem

Below are some optional packages that work alongside pluv.
Expand Down
5 changes: 5 additions & 0 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: "Quickstart"
description: "Learn how to quickly setup and get started with @pluv/io"
---

# Quickstart

Learn how to quickly setup and get started with @pluv/io.
Expand Down

0 comments on commit 8e419cc

Please sign in to comment.