brainbrewlabs/brainbrew-devkit

docs

Build and manage VitePress documentation site.

Ver código-fonte

Como usar

  1. Copie o comando e verifique o pacote antes de instalar no seu ambiente de agente.
  2. Consulte no original as ferramentas, credenciais e ambientes necessários.
  3. Descreva os dados de entrada e a entrega esperada; confira a saída com as fontes.
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill docs

Antes de começar

  • A instalação não inclui assinatura de modelo, franquia API ou acesso aos seus arquivos.
  • Estrelas e instalações indicam atividade, não um teste independente de qualidade ou segurança.
Documento original do Skill

Renderizado do repositório de origem, preservando títulos, exemplos, código, tabelas, links e imagens.

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

Relacionados por tarefa