docs

Build and manage a VitePress documentation site with local preview and GitHub Pages deployment.

7|3|Updated Mar 17, 2026
One-click install
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill docs-brainbrewlabs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/brainbrewlabs/brainbrew-devkit/tree/main/plugin/skills/docs
Command: npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill docs-brainbrewlabs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill removes friction from building, previewing, and deploying a VitePress documentation site by providing clear commands and deployment triggers so maintainers can iterate quickly.

Core Features & Use Cases

  • Local preview: Run a dev server for iterative editing and validation.
  • Production build: Produce a static site output suitable for hosting at docs/.vitepress/dist.
  • Automatic deployment: Trigger GitHub Pages deployment on pushes to main when documentation files change.
  • Use case: A developer updates a guide page, previews the change locally, builds the site, and pushes the update to automatically deploy the new documentation.

Quick Start

Start a local preview of the VitePress site by running npm run docs:dev from the repository root.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I preview VitePress documentation changes locally?

To build a VitePress static site, run the npm script for the production build. This generates the static output files in the docs/.vitepress/dist directory, which can be hosted on any static site hosting platform.

Can I deploy VitePress docs to GitHub Pages automatically?

Yes, VitePress docs can be automatically deployed to GitHub Pages. The deployment is triggered by pushes to the main branch whenever changes are made to files in the docs/ directory, integrating with push- or CI-based deployment workflows.

What is the best way to manage a VitePress documentation site workflow?

The best way to manage a VitePress documentation site is using a workflow that handles local preview, production builds, and deployment. This lets you update a guide page, preview it, build the static output, and push to deploy automatically.

Where does VitePress output the production build files?

VitePress outputs production build files to the docs/.vitepress/dist directory. Running the npm build script produces this static site output, which is suitable for hosting on platforms like GitHub Pages.

Do I need any extra dependencies to build and deploy VitePress static sites?

No extra dependencies are required beyond the standard VitePress setup. The workflow uses npm scripts to start the dev server and produce the static build, integrating directly with push- or CI-based deployment triggers for GitHub Pages.