编辑规则

基本形式

用户编辑SMHO手册上的内容的基本方式为提交“拉取请求”(Pull Request, PR)。关于Pull Request的更多信息可以在GitHub的官方文档（中文/英文）上找到。在这里仅进行最简单的概述。

注：以下操作请在登录GitHub后再进行。

进入SMHO手册的代码仓库(repo)，点击页面右上角的“Fork”，将整个代码仓库复制到您自己的账户中，这个复制得到的仓库称为您的“本地仓库”；
如果您要更改词条内容，可以直接在“本地仓库”中的/docs/item/文件夹下的词条文件夹中更改；如果您要增加词条，请将编写好的词条文件夹上传至“本地仓库”中的/docs/item/文件夹下；具体更改或上传方法略（请遵循GitHub网页上的按钮提示），编写词条的格式以及词条文件夹的构成见下；
在SMHO手册的代码仓库中提请一个新的PR，请求将“本地仓库”合并到SMHO手册的main分支（默认）；
等待审核通过后，您的更改将在SMHO手册中生效。

编辑方法

注：以下内容中，标注(dev)的是针对开发者的提示，普通用户可以跳过。

结构

SMHO手册的词条以文件夹的形式呈现，下面是词条的文件结构图：

[词条文件夹]
     ├── index.md
     └── ...

注意：由于服务器访问机制的未知问题，请使用英语（ASCII字符）的文件夹名称，包括词条文件夹的名称及其所有子文件夹的名称。

SMHO手册的所有词条都应置于/docs/item/文件夹下。

SMHO手册中的词条内容由两部分组成：正文和附件。其中，附件主要为插图。

正文

index.md存储的是正文部分，应由markdown语言写成。SMHO手册提供了GitHub风格的markdown语法，关于GitHub风格的markdown的更多信息请参考官方文档。
除markdown以外，SMHO手册还提供了基于MathJax的$\LaTeX$（LaTeX，一种数学符号标记语言）支持：MathJax默认支持以\[...\]或$$...$$包裹的块状行间公式，SMHO手册还支持以 $...$ 包裹的行内公式。关于$\LaTeX$的更多信息可以在互联网上找到。（需要注意的是，markdown解析器可能错误理解$\LaTeX$代码中的某些特殊字符，这时您需要使用转义，比如用\_代替_，用\\代替\）
(dev)另外，对于markdown无法表现的内容（如字体、颜色等），可以在markdown文件中直接使用原生的HTML代码。

词条的index.md中应有且仅有一个一级（最高级）标题，这个一级标题将被作为此词条的总标题，显示在浏览器上方的标签栏以及搜索页面中。如，某词条中含有的唯一一个一级标题为“xxx”，那么用户访问这个词条时标签栏中的标题就会是“xxx | SMHO手册”。词条的标题只与词条中的一级标题有关，与词条文件夹的名称无关。

(dev)如果不想使用词条中的一级标题作为总标题（不推荐！），可以在index.md的YAML头中加入如下内容：

title: 新标题

您可以添加任意数量的标签。建议您在添加标签前，先查看已有的标签，以免添加含义相近但名称不同的标签。您可以在这里查看已有的标签。SMHO手册的标签是大小写敏感的；另外，请注意尽量不要在标签中使用空格（请用连字符-或下划线_代替）。

注意：事实上，由于SMHO手册的搜索机制是基于标签的，所以您必须为您的词条添加至少一个标签，否则您的词条将无法被搜索到（但仍然可以通过网址访问）。

附件

词条文件夹中除index.md以外的文件都是附件，用户可以自行安排。最简单的形式是在词条文件夹下再建立一个images文件夹用于存储图片。
(dev)除图片以外，可能用到的本词条专用的样式表（CSS）或脚本（javascript）都可以放在词条文件夹下。
需要注意的是，index.md中对图片等附件的引用需要与附件的文件结构相一致。比如，需要引用本词条文件夹下的images文件夹中的图片pic.png，那么在index.md中的引用就应是

![pic](./images/pic.png)

其中，.表示词条文件夹（即index.md所在的文件夹）。

编辑规范

SMHO手册的词条需要遵循一定的规范。

内容必须是真实的、准确的、合法的，请勿上传虚假或非法内容；
结构清晰，由多级标题组成；内容通俗易懂，又不失专业性；
排版美观；

结语

SMHO手册提供了一个词条示例，供参考。

感谢您为SMHO手册做出的伟大贡献！

标签： SMHO手册说明查看所有标签