跳转至主要内容
`Ctrl`+`K`

# 文档贡献指南

本文章将介绍如何为本网站做出贡献。包括文档提交，文档修改等。

## 基本要求

1. 不得包含大量的不实，虚假或谎报内容。

2. 对于未证实的内容，必须标注为未证实/未核实。

3. 文档内容不得包含任何非法或不道德的内容。

4. 涉及到引用他人内容的，必须注明出处并提供原内容。

## 文档提交

### 文档提交方式

#### 使用常规提交方式

当你想要提交新的文档时，首先需要先编写内容，然后以图片, txt, markdown(不过最好选用MyST Markdown)或ReStructuredText等格式提交到管理员。

参见

有关MyST Markdown和ReStructuredText的语法参考，你可以参考一下链接：

- MyST Parser：https://daobook.github.io/MyST-Parser/intro.html

- ReStructuredText：https://dac-tutorial.github.io/dac-tut/rst-guide.html

MyST Markdown的一些语法MyST Parser的文档中提供了详细的语法说明。

出于对各位的考虑，我们建议大家使用MyST Markdown格式，因为它的语法更加简洁，易于阅读和理解。

小技巧

事实上，MyST Parser的官网为https://myst-parser.readthedocs.io/en/latest/

但是，官网只提供英文版的文档。

使用GitHub提交方式

或者，你可以直接在GitHub上创建一个新的分支，然后将修改的内容提交到该分支，最后提交一下。

我们的GitHub仓库地址为：deepclour/TRH-site

需要注意，这是个私人仓库，你需要有GitHub账号，并且需要要找我要权限才可以提交。

文档提交格式

提交文档时，需要在提交的文档中添加以下信息：

- 文档标题

- 文档作者

- 文档内容

以下是一个MyST Markdown格式的示例：

    # 文档标题

    一些概述，等等。

    ## 文档内容

    一些详细内容，等等。

ReStructuredText格式的示例：

    = 文档标题

    一些概述，等等。

    == 文档内容

    一些详细内容，等等。

文档审核

当你提交文档后，管理员会进行审核，审核通过后，文档将被发布到网站上。

同时，你也会被标记为贡献者。

文档修改

如果你发现文档中有错误或需要修改的地方，可以提交修改请求。提交修改请求时，需要在提交的修改请求中添加以下信息：

- 修改出处

- 修改内容

- 修改作者

当你提交修改请求后，管理员会进行审核，审核通过后，修改将被应用到网站上。

同时，你也会被标记为贡献者。

其他

如果你有任何其他问题或需要帮助，请随时联系管理员。管理员将尽力帮助你解决问题。

修改情况

修改情况

1. 2026年7月7日：初始版本发布

2. 2026年7月14日：更新文档提交方法

3. 2026年8月2日：更新文档的提交方式，附上MyST Markdown和ReStructuredText的语法说明链接

博客测试 7月更新说明