brainbrewlabs/brainbrew-devkit

docs

Build and manage VitePress documentation site.

Quelltext ansehen

Verwendung

  1. Installationsbefehl kopieren und das Quellpaket vor der Installation in der eigenen Agentenumgebung prüfen.
  2. Benötigte Werkzeuge, Zugangsdaten und Hosts im Original prüfen.
  3. Eingabe und gewünschtes Ergebnis beschreiben und die Ausgabe mit den Quellen abgleichen.
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill docs

Vor dem Start

  • Die Installation umfasst weder Modellabo noch API-Kontingent oder Dateizugriffsrechte.
  • Sterne und Installationen zeigen Aktivität, keine unabhängige Qualitäts- oder Sicherheitsprüfung.
Originales Skill-Dokument

Aus dem Quell-Repository gerendert; Überschriften, Beispiele, Code, Tabellen, Links und Bilder bleiben erhalten.

Documentation Site

Build Docs

bash
npm run docs:build

Output: docs/.vitepress/dist/

Preview Locally

bash
npm run docs:dev

Opens at http://localhost:5173/brainbrew-devkit/

Deploy to GitHub Pages

Docs auto-deploy on push to main when files in docs/ change.

Manual trigger:

bash
git add docs/ && git commit -m "docs: update" && git push

Or trigger via GitHub Actions UI.

Site Structure

docs/
  index.md              # Landing page
  guide/                # Getting started, tutorials
  skills/               # Skill reference
  templates/            # Workflow templates
  agents/               # Agent reference
  api/                  # MCP tools, hooks

Add New Page

  1. Create docs/<section>/<name>.md
  2. Add to sidebar in docs/.vitepress/config.ts
  3. Build and verify: npm run docs:build

Update Existing Page

  1. Edit the .md file
  2. Preview: npm run docs:dev
  3. Commit and push to deploy

Common Tasks

TaskCommand
Dev servernpm run docs:dev
Buildnpm run docs:build
Preview buildnpm run docs:preview
DeployPush to main

Verwandte Aufgaben