brainbrewlabs/brainbrew-devkit

docs

Build and manage VitePress documentation site.

소스 보기

사용 방법

  1. 설치 명령을 복사하고 자신의 에이전트 환경에 설치하기 전에 소스 패키지를 확인하세요.
  2. 필요한 도구, 인증 정보, 지원 환경은 원본 문서에서 확인하세요.
  3. 입력과 원하는 산출물을 설명하고 출처와 결과를 대조하세요.
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill docs

시작 전 확인

  • 설치에는 모델 구독, API 한도, 파일 접근 권한이 포함되지 않습니다.
  • 별점 수와 설치 수는 활동 지표이며 독립적인 품질·보안 검증이 아닙니다.
원본 Skill 문서

원본 저장소의 제목, 예시, 코드, 표, 링크, 이미지를 유지해 표시합니다.

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

관련 작업