文档库
常用方法
把高频操作放在一页里,维护时不用到处翻命令。
常用链接
| 名称 | 地址 |
|---|---|
| Hugo 文档 | Hugo Documentation |
| Hugo GitHub Pages 部署 | Host on GitHub Pages |
| Doks 文档 | Doks Documentation |
| Doks 快速开始 | Doks Getting Started |
| Docker 文档 | Docker Docs |
| Docker CLI | Docker CLI reference |
| Docker Compose | Docker Compose reference |
| Halo 文档 | Halo Documentation |
| Halo Docker Compose | 使用 Docker Compose 部署 |
| WebStack-Hugo | shenweiyan/WebStack-Hugo |
| AstrBot 文档 | AstrBot Documentation |
| AstrBot GitHub | AstrBotDevs/AstrBot |
| OpenClaw 文档 | OpenClaw Documentation |
| OpenClaw GitHub | openclaw/openclaw |
| Hermes Agent 文档 | Hermes Documentation |
| Hermes Agent GitHub | NousResearch/Hermes-Agent |
| Bootstrap 文档 | Bootstrap Documentation |
常用命令
进入项目:
cd ~/projects/doks-site
启动本地服务:
npm run start -- --port 1324
完整检查:
npm run lint
npm run build
只检查 Markdown:
npm run lint:markdown
只检查样式:
npm run lint:styles
查看改动:
git status --short
git diff --stat
内容放哪里
| 内容 | 推荐位置 |
|---|---|
| 导航站维护 | content/en/docs/webstack/ |
| 文档站维护 | content/en/docs/help/ |
| Docker 教程 | content/en/docs/docker/ |
| AI 助手教程 | content/en/docs/ai/ |
| Halo2 博客部署 | content/en/docs/halo/ |
| 公开长文 | content/en/blog/ |
| 首页入口 | layouts/index.html |
| 菜单配置 | config/_default/menus/menus.en.toml |
新增栏目
新增文档栏目时需要:
- 在
content/en/docs/下创建目录。 - 添加
_index.md。 - 在
config/_default/menus/menus.en.toml增加[[docs]]顶层菜单。 - 子页面 front matter 中设置
menu.docs.parent。 - 跑
npm run build检查侧栏。
右侧目录不显示
检查页面 front matter:
toc: true
还要确认正文有二级标题:
## 标题
如果只有一级标题或没有足够标题,右侧目录可能为空。
左侧导航不对
重点检查:
config/_default/menus/menus.en.toml里是否有顶层[[docs]]。- 页面 front matter 的
menu.docs.parent是否正确。 weight是否合理。- 页面是否在
content/en/docs/下。
样式没生效
先确认改的是源文件:
assets/scss/
layouts/
再重新构建:
npm run build
如果本地生效但线上没生效,检查是否已经提交并推送到 GitHub。
页面太挤或太空
优先看这些样式文件:
| 文件 | 作用 |
|---|---|
assets/scss/layouts/_pages.scss | 首页和文档页主体布局 |
assets/scss/layouts/_sidebar.scss | 左侧导航和右侧目录 |
assets/scss/layouts/_header.scss | 顶部导航 |
assets/scss/common/_dark.scss | 深色模式 |
修改后同时检查浅色和深色模式。
敏感信息规则
不要写进文档或提交到仓库:
.env中的真实值。- 数据库密码。
- API Token。
- Cookie。
- 私钥。
- 数据库文件。
- 备份包。
可以写变量名和示例占位符,例如 HALO_DB_PASSWORD,但不要写真实密码。
三个站点怎么分工
| 站点 | 作用 |
|---|---|
| 导航站 | 常用入口和资源导航 |
| 文档站 | 教程、命令、部署和排障手册 |
| 博客站 | 对外博客文章和长期内容 |
简单入口放导航站,操作流程放文档站,完整文章放博客。