brainbrewlabs/brainbrew-devkit

docs

Build and manage VitePress documentation site.

使用方法

复制安装命令，在自己的智能体环境安装前先检查源码包。
从原始文档核对所需工具、凭据和支持的宿主。
说明输入材料与期望交付物，并对照来源检查输出。

npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill docs

开始前需了解

安装不包含模型订阅、API 额度或访问文件的权限。
仓库星数和安装量反映活跃情况，不等于独立质量或安全测试。

仓库原始内容

按源仓库内容呈现，保留标题、案例、代码、表格、链接以及原文引用的演示图片。

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

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

Update Existing Page

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

Common Tasks

Task	Command
Dev server	`npm run docs:dev`
Build	`npm run docs:build`
Preview build	`npm run docs:preview`
Deploy	Push to main

docs

使用方法

开始前需了解

Documentation Site

Build Docs

Preview Locally

Deploy to GitHub Pages

Site Structure

Add New Page

Update Existing Page

Common Tasks

按任务相关推荐

setup-matt-pocock-skills

backend-patterns

context-budget

ecc-guide