mkdocs requirements-docs.txt

目的：定义 docs 依赖 关联：[B1-9]

---

1. requirements-docs.txt

mkdocs==1.6.1
mkdocs-material==9.5.0
pymdown-extensions==10.7
mkdocs-validate-links==0.5.0

4 包。

---

2. 3 步集成

2.1 Step 1: 创建

touch requirements-docs.txt

1 文件。

2.2 Step 2: CI 安装

- run: pip install -r requirements-docs.txt

1 行。

2.3 Step 3: 本地开发

pip install -r requirements-docs.txt

1 行。

---

3. 完整依赖

# Core
mkdocs==1.6.1
mkdocs-material==9.5.0

# Extensions
pymdown-extensions==10.7
pygments==2.17

# Plugins
mkdocs-validate-links==0.5.0

# 可选
mkdocs-minify-plugin==0.7
mkdocs-include-markdown-plugin==4.0

9 包。

---

4. 5 个最佳实践

1. 固定版本 —— ==
2. CI 一致 —— 同一 lockfile
3. 定期更新 —— 月度
4. 分开 dev/prod —— requirements-docs / requirements-build
5. lockfile —— pip freeze

---

5. 5 个反模式

1. ❌ 无版本 (mkdocs)
2. ❌ 只装主包不装扩展
3. ❌ 装多版本冲突
4. ❌ 装不必要的包
5. ❌ 不更新

---

6. 总结

requirements-docs.txt = 4 必需包 + 5 实践。

下一步： - 看 B1-10 GitHub Pages