怎样修改网站内容¶

如果你想要为本网站进行修改贡献，以下是一些指南。

本地构建¶

1. 克隆本项目 repo

git clone git@github.com:syt-nju/cca-tutorial.git
cd cca-tutorial

也可以使用http协议

2. 安装依赖(请确保拥有 python 环境和 pip)

pip install mkdocs

如果必要，可能还需要执行：

pip install mkdocs-material-extensions
pip install pymdown-extensions

3. 启动 mkdocs 本地服务

mkdocs serve

之后即可通过浏览器访问 127.0.0.1:8000 预览网站。 在 cca-tutorial 文件夹下执行，把本地修改好的东西编译，生成一个本地端口，便于检查修改后的效果

将这个 127.0.0.1:8000 网址用浏览器打开即可查看修改后的网站效果

4. 本地编译后对网站进行修改

mkdocs gh-deploy

贡献内容¶

网站结构¶

在源代码层面，使用 markdown 编写，文件夹内 index.md 为主页，文件夹内可以存放图片素材等。整体结构在 mkdocs.yml 文件中的 nav 部分定义。

├── docs                # 网站上所有的内容，主要以 markdown 或者 html 文件的形式存在
|   |—— index.md        # 主页
|   |—— img/            # 图片
├── mkdocs.yml          # mkdocs 站点设置

贡献守则¶

你可以对本网站进行任何贡献，包括完善、更新页面内容，添加新页面，样式修改等等。只需关注 docs 文件夹以及 mkdocs.yml 文件。

添加新页面请记得更新 mkdocs.yml 的 nav 部分。以下是参考样式内容：

site_name: CCA Tutorial
nav: 
  - Home: index.md  
  - To Newcomers: 
    - 简介: 简介.md
  - Tutorial:  
    - 网站修改教程: 网站修改教程.md
    - 如何添加英雄: 简单英雄构建流程.md
  - Infos: 
    - 英雄文档: CCA英雄.md
theme: readthedocs

贡献方式¶

• 将自己的 git 账号发给 syt ，获得仓库权限。
• 将仓库 clone 到本地，首先执行 git pull 同步别人的修改。
• 修改你想修改的文件，注意维护 nav。
• 本地 mkdocs serve 查看效果，确认无误后 mkdocs gh-deploy。
• git add, commit, push 将本地修改同步到远程仓库。