快速开始

本页介绍如何运行与扩展本站点。

环境要求

• Node.js 18 及以上版本
• npm / pnpm / yarn 任一包管理器

安装依赖

npm install

启动本地开发服务器

npm run docs:dev

启动后，浏览器访问终端输出的地址（默认 http://localhost:5173），即可实时预览文档。

构建与预览

# 构建静态产物（输出到 docs/.vitepress/dist）
npm run docs:build

# 本地预览构建产物
npm run docs:preview

目录结构

second-brain-web/
├─ docs/                    # 文档根目录（VitePress 默认入口）
│  ├─ .vitepress/           # 站点配置
│  │  └─ config.mts         # 站点配置（标题 / 路由 / 主题）
│  ├─ index.md              # 首页
│  └─ guide/                # 指南文档
│     └─ getting-started.md
└─ package.json             # 依赖与脚本声明

下一步

• 在 docs/.vitepress/config.mts 中调整站点标题、base 路由与导航。
• 在 docs/ 下按主题新建目录与 .md 文件，并在配置的 sidebar 中登记。
• 需要更强定制时，可创建 .vitepress/theme/index.ts 扩展默认主题。