使い方
- インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
- 必要なツール、認証情報、対応環境を原文で確認します。
- 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill docs開始前の確認
- 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
- スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文
見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。
Documentation Site
Build Docs
bash
npm run docs:buildOutput: docs/.vitepress/dist/
Preview Locally
bash
npm run docs:devOpens 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 pushOr 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, hooksAdd 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
.mdfile - 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 |
