维护规范
新增笔记放哪里?
| 内容类型 | 放入位置 |
|---|---|
| 语法规则 | docs/grammar/ |
| 单词、易混词 | docs/vocabulary/ |
| 固定表达、口语句子 | docs/expressions/ |
| 大表格、速查表 | docs/reference/ |
| 想做索引的关键词 | Markdown 标题,或 <!-- index: ... --> 注释 |
推荐条目模板
## 关键词
含义:
用法:
例句:
注意:
维护原则
- 不要把新笔记直接堆到首页。
- 同一个词只保留一个主条目,其他页面用链接指过去。
- 易混词必须放在同一个小节中对比。
- 表格型内容优先放到
reference/,正文页只写解释和链接。 - 每次新增重要词条后,直接运行
mkdocs serve或mkdocs build,索引会自动更新。
自动索引
索引页 docs/index-list.md 由脚本生成,不建议直接手改。mkdocs serve 和 mkdocs build 会通过 tools/generate_index.py 自动刷新它。
默认规则:
- 每个 Markdown 页面里的
#、##、###等标题都会进入索引。 - 表格行、别名、同义词如果也需要进入索引,可以在相关小节下写隐藏注释:
<!-- index: kan, kunde, måste -->
手动刷新命令:
python tools/generate_index.py
推荐命令
本地预览:
mkdocs serve
生成静态网页:
mkdocs build