Golang 高级后端工程师知识库

这是一个基于 Material for MkDocs 搭建的中文技术知识库，用来持续编写“从新手成长为高级 Golang 后端工程师”的系统化教材。

本地启动

安装依赖：

python -m pip install -r requirements.txt

启动预览服务：

python -m mkdocs serve

默认访问地址：

http://127.0.0.1:8000

构建静态站点

python -m mkdocs build

构建结果会输出到 site/ 目录。

发布到 GitHub Pages

本项目使用 GitHub Actions 自动发布到 GitHub Pages。

触发方式：

• 推送到 master 分支时自动发布。
• 在 GitHub Actions 页面手动执行 Deploy docs workflow。

发布流程：

1. 安装 requirements.txt 中的依赖。
2. 执行 python -m mkdocs build --strict。
3. 执行 python -m mkdocs gh-deploy --force。
4. 将生成的静态站点推送到 gh-pages 分支。

首次启用时，需要在 GitHub 仓库设置中打开 Pages：

Settings -> Pages -> Build and deployment -> Source: Deploy from a branch
Branch: gh-pages / root

发布地址：

https://study.yxuefeng.com/

自定义域名

本知识库使用子域名：

study.yxuefeng.com

项目通过 docs/CNAME 声明 GitHub Pages 自定义域名。阿里云 DNS 需要添加：

记录类型：CNAME
主机记录：study
记录值：yleoer.github.io
TTL：默认

GitHub 仓库 Pages 设置中需要填写：

Settings -> Pages -> Custom domain -> study.yxuefeng.com

DNS 生效并且 GitHub 证书签发完成后，开启：

Enforce HTTPS

内容结构

• mkdocs.yml：站点配置、主题配置和导航。
• docs/index.md：知识库首页。
• docs/overview/curriculum.md：完整教学大纲。
• docs/overview/writing-guide.md：后续教材编写规范。
• docs/projects/：特色实战项目入口。

后续通过 Codex 编写教材时，优先在 docs/ 下新增或修改 Markdown 文件，并同步更新 mkdocs.yml 中的导航。