Skip to content

VitePress 搭建

初始化

bash
mkdir my-docs && cd my-docs
npm init -y
npm add -D vitepress vue

目录结构

docs/
├── .vitepress/
│   └── config.mts    # 站点配置
├── index.md          # 首页
├── android/          # 内容目录
├── ios/
└── ...

配置示例

typescript
import { defineConfig } from 'vitepress'

export default defineConfig({
  title: 'My Docs',
  description: '技术文档',
  themeConfig: {
    nav: [
      { text: '指南', link: '/guide/' },
    ],
    sidebar: {
      '/guide/': [
        { text: '快速开始', link: '/guide/getting-started' },
      ],
    },
  },
})

本地预览

bash
npx vitepress dev docs      # 开发
npx vitepress build docs    # 构建

基于 VitePress 构建