Skip to content

README.md

Latest commit

 

History

History
72 lines (43 loc) · 1.63 KB

README.md

File metadata and controls

72 lines (43 loc) · 1.63 KB

Documentation | Issues | Discord

PulseBeam Docs

PulseBeam Logo

This repository contains the source code and content for the official PulseBeam Documentation. 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.

npm install

Step 2. Run Development Server

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:

---
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:

<Callout type="info">
  Host networking is recommended for Linux deployments.
</Callout>

Code Blocks:

Standard markdown fences (```) are automatically syntax-highlighted.

Related