{"id":25170921,"url":"https://github.com/pulsebeamdev/docs","last_synced_at":"2026-02-09T07:34:04.254Z","repository":{"id":266346129,"uuid":"897579935","full_name":"PulseBeamDev/docs","owner":"PulseBeamDev","description":" PulseBeam’s documentation ","archived":false,"fork":false,"pushed_at":"2025-12-30T14:26:50.000Z","size":229,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-02T05:34:59.978Z","etag":null,"topics":["docs"],"latest_commit_sha":null,"homepage":"https://docs.pulsebeam.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PulseBeamDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-02T21:52:21.000Z","updated_at":"2025-12-30T14:26:54.000Z","dependencies_parsed_at":"2025-01-06T17:20:08.332Z","dependency_job_id":"7d5ca694-4d9c-4c05-8bb1-aaa0bb01ae13","html_url":"https://github.com/PulseBeamDev/docs","commit_stats":null,"previous_names":["pulsebeamdev/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PulseBeamDev/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PulseBeamDev%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PulseBeamDev%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PulseBeamDev%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PulseBeamDev%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PulseBeamDev","download_url":"https://codeload.github.com/PulseBeamDev/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PulseBeamDev%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29258759,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-09T04:11:57.159Z","status":"ssl_error","status_checked_at":"2026-02-09T04:11:56.117Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs"],"created_at":"2025-02-09T09:17:06.757Z","updated_at":"2026-02-09T07:34:04.249Z","avatar_url":"https://github.com/PulseBeamDev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[Documentation](https://docs.pulsebeam.dev) | [Issues](https://github.com/PulseBeamDev/docs/issues) | [Discord](https://discord.com/invite/Bhd3t9afuB)\n\n\n# PulseBeam Docs\n\n\u003cimg align=\"right\" src=\"https://pulsebeam.dev/favicon.svg\" height=\"64px\" alt=\"PulseBeam Logo\"\u003e\n\nThis 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.\n\n## Quickstart\n\nRun the documentation site locally to preview changes.\n\n### Step 1. Install Dependencies\n\n**Node.js 18+ required.**\n\n```bash\nnpm install\n```\n\n### Step 2. Run Development Server\n\n```bash\nnpm run dev\n```\n\nOpen http://localhost:3000 to view the docs.\n\n## Writing Documentation\n\nContent is located in `content/`. We use **MDX** (Markdown + React components).\n\n### File Structure\n\n*   `content/*.mdx`: The actual documentation pages. The file path determines the URL.\n*   `app/source.ts`: Configuration for the content source adapter.\n\n### Adding a Page\n\nCreate a new `.mdx` file in `content/`. Every file requires a frontmatter block at the top:\n\n```mdx\n---\ntitle: Quickstart\ndescription: How to run PulseBeam in 5 minutes.\n---\n\n# Quickstart\n\nYour content goes here...\n```\n\n### Components\n\nWe use Fumadocs, which supports standard Markdown and React components.\n\n**Callouts:**\n\n```tsx\n\u003cCallout type=\"info\"\u003e\n  Host networking is recommended for Linux deployments.\n\u003c/Callout\u003e\n```\n\n**Code Blocks:**\n\nStandard markdown fences (` ``` `) are automatically syntax-highlighted.\n\n## Related\n\n*   **[PulseBeam Server](https://github.com/pulsebeamdev/pulsebeam)**: The core WebRTC SFU.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpulsebeamdev%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpulsebeamdev%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpulsebeamdev%2Fdocs/lists"}