关于本站

Everyone Create Community（每个人创作社区）的官方文档站，托管于 GitHub Pages，访问地址 docs.git.eocc.top。

站点是怎么运作的

本站由 MkDocs 构建，使用 Material 主题：

• 所有页面源文件都是 Markdown（存放在仓库的 docs/ 目录）
• 构建工具 MkDocs 把 Markdown 编译成纯静态 HTML
• 编译产物推送到 GitHub 仓库 eoccc/eoccc.github.io，由 GitHub Pages 对外服务

整个过程没有后端服务器：搜索、导航等功能都在构建期生成、由浏览器端 JS 完成。

修改文档的完整流程

从改动到上线，一共四步：

1. 准备环境

# 安装 Python 后执行
pip install mkdocs mkdocs-material

# 克隆仓库
git clone https://github.com/eoccc/eoccc.github.io.git
cd eoccc.github.io

2. 本地修改与预览

在 docs/ 目录中编辑或新增 .md 文件，然后实时预览：

mkdocs serve
# 浏览器打开 http://127.0.0.1:8000，保存即自动刷新

编写规范：

• 一个主题一个文件，文件名用英文小写
• 标题从 # 开始逐级使用，不要跳级
• 图片放入 docs/img/，用相对路径引用
• 新页面记得在 mkdocs.yml 的 nav 中登记，否则不会出现在导航里

3. 提交 Pull Request

git checkout -b docs/my-edit     # 新建分支
git add . && git commit -m "docs: 说明你的改动"
git push origin docs/my-edit

然后到 GitHub 仓库页面点击 Compare & pull request，填写改动说明后提交。审核通过合并即生效。

也可以不装任何工具：直接在 GitHub 网页上打开 docs/ 里的文件，点右上角铅笔图标编辑，完成后同样提交 PR。

4. 更新上线

合并后由维护者执行构建并推送静态产物，GitHub Pages 自动重新发布，通常 1 分钟内生效。用户端如未立即看到更新，多为浏览器缓存，强制刷新（Ctrl+F5）即可。

核心功能

功能	说明
全站搜索	MkDocs 内置搜索，纯前端实现，无需后端
响应式界面	Material 主题，桌面 / 移动端自适应
版本化管理	全部内容由 Git 管理，历史可追溯、可回滚
自动化部署	合并后构建为纯静态 HTML 发布到 GitHub Pages

注意事项

• docs/CNAME 为自定义域名配置，请勿删除，否则域名解析失效
• 仓库根目录的 release/update/ 为版本更新子站，其内容生成流程独立于 MkDocs，改动请联系维护者

版权归属

• 文档内容采用 CC BY-SA 4.0 许可发布，转载需署名并相同方式共享
• 代码与站点配置遵循仓库所在许可
• © Everyone Create Community（EOCC）