本地开发
环境要求
- Node.js ≥ 18(推荐 20 LTS 或 22)
- npm ≥ 9
常用命令
bash
# 安装依赖
npm install
# 启动本地开发服务器(默认 http://localhost:5173)
npm run docs:dev
# 构建静态站点(输出到 docs/.vitepress/dist)
npm run docs:build
# 本地预览构建产物
npm run docs:preview目录结构
FuHeng-WiKi/
├── docs/
│ ├── .vitepress/
│ │ └── config.mjs # 站点配置(导航、侧边栏、主题)
│ ├── index.md # 首页(Hero + Features 布局)
│ ├── guide/ # 指南
│ ├── frontend/ # 前端学习
│ ├── tools/ # 工具与效率
│ └── projects/ # 项目沉淀
├── .github/
│ └── workflows/
│ └── deploy.yml # GitHub Actions 持续部署配置
└── package.json新增一篇笔记
- 在
docs/对应栏目下新建xxx.md; - 在
docs/.vitepress/config.mjs的sidebar对应分组中加入条目; - 提交并推送,GitHub Actions 会自动构建发布。
写作规范
- 文件名使用小写英文字母和连字符(kebab-case);
- 每页以一个
# 标题开头; - 相对链接直接写路径,如
[Vite 速查](/frontend/vite)。