这本手册是什么

一份给未来的自己看的 HomeLab 运维手册——也是 VitePress 三栏文档布局的现场演示。

你现在看到的就是它的全部结构:

区域	内容	来源
左栏	章节导航	config.mts 里的 sidebar 配置
中栏	正文	Markdown,想写什么写什么
右栏	本页目录	自动扫描正文 ## / ### 生成

试一试

• 滚动页面,右栏的当前小节会跟着高亮
• 按 Ctrl/Cmd + K 打开本地全文搜索
• 右上角可以切深浅色
• 左栏章节点击即跳,当前页自动标记

为什么选 VitePress

写的人只碰 Markdown,三栏、搜索、代码高亮、移动端折叠全部是渲染层的事。

它替你做了什么

1. ## 标题自动进右栏目录,带锚点和滚动监听
2. 代码块自动语法高亮,支持行高亮和行号
3. cleanUrls 让链接不带 .html,丢在 Caddy 后面毫无违和感
4. build 产物是纯静态文件,塞进现有 file_server 就能上线

它不替你做什么

• 章节顺序要自己在 sidebar 里声明(也可以上插件自动生成)
• 图片、附件要自己放进 public/

这本手册的内容组织

docs/
├─ index.md                  ← 你现在这页
├─ get-started/
│  ├─ quick-start.md         5 分钟起一个服务
│  └─ install.md             Docker / 源码 / systemd 三种装法
├─ reference/
│  ├─ config.md              环境变量速查表
│  └─ commands.md            常用命令,按场景翻
└─ faq.md                    踩过的坑都在这里

下一页

从快速开始看起,或直接点左栏跳章。

---

本站由 git push 自动构建发布 · 源码仓库