brainbrewlabs/brainbrew-devkit

docs

Build and manage VitePress documentation site.

Voir la source

Mode d’emploi

  1. Copiez la commande et examinez le paquet avant de l’installer dans votre environnement agent.
  2. Consultez le document original pour les outils, identifiants et environnements requis.
  3. Décrivez les entrées et le livrable souhaité ; comparez la sortie aux sources.
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill docs

Avant de commencer

  • L’installation n’inclut ni abonnement au modèle, ni quota API, ni accès aux fichiers.
  • Étoiles et installations reflètent l’activité, pas un test indépendant de qualité ou de sécurité.
Document Skill original

Rendu depuis le dépôt source en conservant titres, exemples, code, tableaux, liens et images.

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

Tâches connexes