Quick Start

Environment Requirements

• Node.js >= 18.0.0
• npm >= 9.0.0

Install Dependencies

npm install

Development Mode

Start the development server:

npm run dev

Visit http://localhost:5173 to view the website.

Build

Build for production:

npm run build

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

Preview

Preview the production build:

npm run preview

Adding Documentation

1. Create .md files in docs/guide/ or docs/api/ directories
2. Update navigation and sidebar configuration in docs/.vitepress/config.ts
3. Restart the development server to see the changes

Custom Configuration

Edit the docs/.vitepress/config.ts file to customize:

• Site title and description
• Navigation menu
• Sidebar
• Theme configuration
• Social links And more