https://github.com/pulsebeamdev/docs
PulseBeam’s documentation
https://github.com/pulsebeamdev/docs
docs
Last synced: 5 months ago
JSON representation
PulseBeam’s documentation
- Host: GitHub
- URL: https://github.com/pulsebeamdev/docs
- Owner: PulseBeamDev
- License: agpl-3.0
- Created: 2024-12-02T21:52:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-30T14:26:50.000Z (6 months ago)
- Last Synced: 2026-01-02T05:34:59.978Z (6 months ago)
- Topics: docs
- Language: TypeScript
- Homepage: https://docs.pulsebeam.dev
- Size: 224 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[Documentation](https://docs.pulsebeam.dev) | [Issues](https://github.com/PulseBeamDev/docs/issues) | [Discord](https://discord.com/invite/Bhd3t9afuB)
# PulseBeam Docs
This repository contains the source code and content for the official [PulseBeam Documentation](https://docs.pulsebeam.dev). If you see the current documentation is lacking, please feel free to create pull requests.
## Quickstart
Run the documentation site locally to preview changes.
### Step 1. Install Dependencies
**Node.js 18+ required.**
```bash
npm install
```
### Step 2. Run Development Server
```bash
npm run dev
```
Open http://localhost:3000 to view the docs.
## Writing Documentation
Content is located in `content/`. We use **MDX** (Markdown + React components).
### File Structure
* `content/*.mdx`: The actual documentation pages. The file path determines the URL.
* `app/source.ts`: Configuration for the content source adapter.
### Adding a Page
Create a new `.mdx` file in `content/`. Every file requires a frontmatter block at the top:
```mdx
---
title: Quickstart
description: How to run PulseBeam in 5 minutes.
---
# Quickstart
Your content goes here...
```
### Components
We use Fumadocs, which supports standard Markdown and React components.
**Callouts:**
```tsx
Host networking is recommended for Linux deployments.
```
**Code Blocks:**
Standard markdown fences (` ``` `) are automatically syntax-highlighted.
## Related
* **[PulseBeam Server](https://github.com/pulsebeamdev/pulsebeam)**: The core WebRTC SFU.