快速开始
几条命令即可跑通：init → 写 Markdown → dev → build → deploy。
初始化
pnpm create vitepress@latest docs
cd docs
pnpm install
pnpm dev
目录要点：
docs/.vitepress/config.ts配置站点信息、导航、侧边栏。docs/index.md首页，其他 Markdown 自动映射路由。
基础配置示例
// .vitepress/config.ts
import { defineConfig } from 'vitepress';
export default defineConfig({
title: 'My Docs',
description: 'Example',
themeConfig: {
nav: [{ text: '指南', link: '/guide/' }],
sidebar: {
'/guide/': [
{ text: '介绍', link: '/guide/' },
{ text: '开始', link: '/guide/getting-started' },
],
},
search: { provider: 'algolia', options: { appId: '', apiKey: '', indexName: '' } },
},
});
常用脚本
- 开发：
pnpm dev - 构建：
pnpm build（产物在.vitepress/dist） - 预览：
pnpm preview
部署
- 将
.vitepress/dist部署到任意静态托管（CF Pages/Netlify/Vercel）。 - 若站点有子路径，设置
base。***