brainbrewlabs/brainbrew-devkit

docs

Build and manage VitePress documentation site.

Vedi sorgente

Come usare

  1. Copia il comando e controlla il pacchetto prima di installarlo nel tuo ambiente agente.
  2. Controlla strumenti, credenziali e ambienti richiesti nel documento originale.
  3. Descrivi input e risultato desiderato; confronta l’output con le fonti.
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill docs

Prima di iniziare

  • L’installazione non include abbonamenti, quote API o accesso ai file.
  • Stelle e installazioni indicano attività, non un test indipendente di qualità o sicurezza.
Documento Skill originale

Contenuto dal repository con titoli, esempi, codice, tabelle, link e immagini preservati.

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

Correlati per attività