Skip to content

docs: 迁移文档从 Sphinx/ReadTheDocs 到 MkDocs Material/GitHub Pages#870

Merged
jhao104 merged 1 commit into
masterfrom
develop
May 27, 2026
Merged

docs: 迁移文档从 Sphinx/ReadTheDocs 到 MkDocs Material/GitHub Pages#870
jhao104 merged 1 commit into
masterfrom
develop

Conversation

@jhao104
Copy link
Copy Markdown
Owner

@jhao104 jhao104 commented May 27, 2026

  • 新增 MkDocs Material 主题配置(indigo 配色、暗色模式、搜索、即时加载)
  • 新增 GitHub Actions 自动部署 workflow
  • 从头重写全部文档为 Markdown(首页、快速开始、配置参考、API、Docker、扩展、变更日志)
  • 修正旧文档中 API 端点名称与代码不一致的问题
  • 补充 PROXY_REGION、TIMEZONE 等缺失配置项说明
  • 更新 README 文档链接指向 GitHub Pages
  • 删除旧 Sphinx 配置和 RST 文件

- 新增 MkDocs Material 主题配置(indigo 配色、暗色模式、搜索、即时加载)
- 新增 GitHub Actions 自动部署 workflow
- 从头重写全部文档为 Markdown(首页、快速开始、配置参考、API、Docker、扩展、变更日志)
- 修正旧文档中 API 端点名称与代码不一致的问题
- 补充 PROXY_REGION、TIMEZONE 等缺失配置项说明
- 更新 README 文档链接指向 GitHub Pages
- 删除旧 Sphinx 配置和 RST 文件
@jhao104 jhao104 merged commit 5c8f25f into master May 27, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant