X-DIY

X·Lab EE自学手册项目，基于mkdocs+GitHub WebHooks，实现了自动同步git push自动更新网页内容。

• X-DIY
  • 分支 | Branches
  • 架构说明 | Tree
  • 使用方法 | Usage
    • 1. clone仓库
    • 2. 进入相应文件夹
    • 3. 更改文档内容
    • 4. 提交代码到main分支
  • 给新人：如何向X-DIY添加内容
    • 1. 将本仓库Fork到你的账户中：
    • 2. 将你账户中的仓库Clone到本地
    • 3. 做出更改，Commit到你自己的仓库
    • 4. 提交Pull Request
    • 5. 等待管理员手动将Pull request整合到主页面中

网页地址：https://zjuxlab.github.io/X-DIY/

分支 | Branches

• main：文档主要内容
• webhooks：用于构建GitHub WebHooks，实现自动同步更新网页内容
• gh-pages：site目录内容，用于构建GitHub Pages

说明：我们在开发网页过程中只需要维护main分支，其余两个分支我已配置好，不用更改。

架构说明 | Tree

• wiki目录存放网页内容，wiki/docs中的Markdown文件表示网页显示的内容，其结构可在官方文档中查看。

使用方法 | Usage

1. clone仓库

git clone https://github.com/zjuxlab/X-DIY.git

2. 进入相应文件夹

cd X-DIY

3. 更改文档内容

说明：采用Markdown语法，如插入图片推荐在仓库中单独开一个assets目录用于存储图片，后续由@SuperbRa1n统一上传到图床，也可以自行采用对象存储的方式（详见内训文档的3.2.2部分）。

4. 提交代码到main分支

git add .
git commit -m"commit messages"
git push origin main

说明：提交过后服务器自动更新网页可能有一定的延迟。

给新人：如何向X-DIY添加内容

1. 将本仓库Fork到你的账户中：

2. 将你账户中的仓库Clone到本地

# 格式：
git clone https://github.com/[你的账户名]/[Fork的仓库名].git
#例如：
git clone https://github.com/tsaoo/X-DIY.git

3. 做出更改，Commit到你自己的仓库

文档/wiki/docs中。作为例子，我在/wiki/docs/工具/优质资源合集中添加了一个点号。现在，保存这一更改，将其提交并上传到云端：

cd D:\Projects\Xdiy\X-DIY           #转到工程根文件夹
git add .                           #将所有更改添加到缓存
git status                          #检查你的更改
git commit -m 'Add an extra dot'    #告诉大家你干了啥
git push origin main                #将你的修改提交到云端的main分支

4. 提交Pull Request

在你自己的仓库中，点击Contribute->Open pull request

往下翻一点，你可以在提交前检查更改的内容。

5. 等待管理员手动将Pull request整合到主页面中

注意：你可以自己建新页面，也可以修改已经存在的页面，或者将某个页面移动到其它分类下——你想怎么改就怎么改，管理员会人肉处理任何可能的冲突。