如何为本网站作出贡献

本页面由张大佑编辑并发布

网站简介

本网站采用 MkDocs 作为静态网站生成工具，使用 mkdocs-material 主题进行美化，并通过 GitHub Pages 实现自动部署。我们已配置 GitHub Actions 实现远程仓库同步后自动构建和发布。

工作流程概述

本页面涉及基础的 Git 与 GitHub 操作。如果你不熟悉这些内容，可以查阅 GitHub 官方文档 或参考本网站的 AI工具 页面获取辅助。

如果你希望修改或新增页面，请按照以下步骤操作：

1. 申请仓库权限

你可以联系网站维护者申请协作权限，获得直接提交到远程仓库的能力。或者你也可以通过 GitHub 的 Fork 功能复制仓库，编辑后通过 Pull Request（简称 PR）提交你的更改。

2. 拉取远程仓库到本地

仓库地址：艺数盒子文档

• 推荐使用 Git 工具或 GitHub Desktop 进行操作。
• 命令行示例：
  

  git clone https://github.com/wuzhineihan/ArtTech-Document.git
  

3. 本地编辑项目结构说明

项目主要由以下部分组成：
- docs/ 文件夹：存放所有文档（Markdown 文件）及附件（如图片）。
- site/ 文件夹：保存网站构建后的静态文件，无需手动编辑。
- mkdocs.yml：网站配置文件，包含导航目录、主题、插件等设置。

编辑与新增页面

• 编辑已有文章：直接修改 docs/ 下对应的 .md 文件。
• 新建文章：根据内容分类，将新 .md 文件放入合适的子文件夹，并在 mkdocs.yml 中添加导航。
• 添加图片或附件：请将文件存放在 docs/assets/ 下的对应文件夹。

导航配置说明：
在 mkdocs.yml 文件中添加导航时，Markdown 文件路径是相对于 docs 文件夹的。

4. 本地预览与调试

编辑完成后，建议先在本地预览网站效果：

1. 打开终端（如 PowerShell），切换到项目根目录。
2. 构建网站：
   

   mkdocs build
   

   
   如果没有报错或仅有可接受的警告，继续下一步。
3. 启动本地服务器：
   

   mkdocs serve
   

4. 在浏览器访问 http://127.0.0.1:8000/ 查看效果。

5. 提交与同步

确认无误后，可以将更改提交到远程仓库：
- 使用 git add .、git commit -m "描述"、git push 完成同步。
- 等待 GitHub Actions 自动构建和部署，几分钟后即可在网站上看到更新。

---

新手常见问题解答

• 什么是 Markdown？
  Markdown 是一种轻量级标记语言，适合编写结构化文档。你只需用简单的语法即可实现标题、列表、链接、图片等效果。

• 什么是 Git？
  Git 是一个分布式版本控制系统，用于管理代码和文档的历史记录。你可以随时回退、合并、同步更改。

• 什么是 GitHub？
  GitHub 是一个基于 Git 的代码托管平台，支持协作开发、版本管理和自动化部署。

• 什么是 Pull Request？
  PR 是一种协作方式，允许你将自己的更改提交给原仓库，由维护者审核后合并。

• mkdocs.yml 怎么写？
  只需按照已有格式添加你的页面路径，注意缩进和层级。

• 图片怎么插入？
  推荐将图片放在 docs/assets/images/ 文件夹，并用如下语法引用：
  

  ![描述](../assets/images/图片名.png)
  

---

如有疑问，欢迎在社团交流群或 GitHub Issue 区留言，或直接联系网站维护者。祝你编辑愉快，欢迎为本网站贡献内容！