Skip to content

Quick Start

This guide will help you quickly get started with this project.

Requirements

  • Node.js 18 or higher
  • npm or pnpm

Install Dependencies

bash
npm install

Start Development Server

bash
npm run docs:dev

Visit http://localhost:5173 to view the documentation site.

Build for Production

bash
npm run docs:build

The build artifacts will be output to the docs/.vitepress/dist directory.

Preview Production Version

bash
npm run docs:preview

Adding New Documents

  1. Create a new .md file in the docs/ directory.
  2. Update the sidebar configuration in docs/.vitepress/config.js.

Tip

VitePress supports using Vue components in Markdown, allowing you to create richer interactive content.

Released under the MIT License.