For the complete DHIS2 documentation index, see llms.txt.

DHIS 2文档指南¶

DHIS 2文档系统概述¶

DHIS 2 是一个非常活跃的基于网络的信息管理系统开发通常每年有两个主要版本。每次发布通常包括许多新功能和附加功能功能。由于发展速度快，该系统的范围广泛用户基础分散、发展全球性、综合性需要文档系统。

在本章中，我们将描述DHIS 2的文档系统以及您如何可以做出贡献。

介绍¶

DHIS 2文档以[Commonmark]（https://commonmark.org）降价格式编写。降价的主要优势之一是内容和演示文稿之间完全分开。 Commonmark是一个严格定义的，高度兼容的规范降价。由于markdown可以转换为多种格式（HTML， PDF等），并且是基于文本的格式，它是系统文档。

存在各种各样的文本编辑器，可用于创建降价文件。对于Linux和Windows， [ghostwriter]（https://wereturtle.github.io/ghostwriter/）是一个不错的选择；它是免费的，并支持并排预览和自定义样式表。

在编写文档时要记住的关键概念之一 Markdown 或其他呈现中性格式，是内容应首先考虑该文件的内容。演示文件将在单独的转换步骤中进行，其中源文本将呈现为不同的格式，例如 HTML 和 PDF。因此，该文件的组织良好和结构化，具有适当的标签和结构元素经过考虑的。

优良作法是使用以下方法将文档分为多个部分：本节标题。这样，可以将非常复杂的章节分成较小的，更易于管理的部分。此概念与Microsoft Word或其他单词基本相同处理程序。渲染过程将自动处理编号生成文档时为您提供的部分。

GitHub入门¶

DHIS 2 文档系统的管理地址为 GitHub 跨多种来源代码存储库。 GitHub 是一个平台，使多人协作开发软件项目。为了为此，需要版本控制系统管理多个用户可能做出的所有更改。 GitHub 使用 git 源代码控制系统。虽然这超出了本文的范围描述 git 功能的文档，希望的用户创建文档需要至少对以下内容有基本的了解系统如何运作。下一节将提供基本指南。这读者可参考git手册了解更多信息。

为了开始添加或编辑文档，您应该首先执行源代码的签出。如果您还没有 GitHub 帐户，您需要获得一个。这可以做到此处。注册 GitHub 后，您将如果您愿意，需要请求访问 dhis2-documenters 组直接修改文档的源代码。然而，任何人可以将文档克隆到自己的存储库中，提交对该分支进行更改，并请求将更改合并到带有对父存储库的拉取请求的文档来源。

文档站点的结构在构建存储库 dhis2-docs-builder 中定义。如果您想向结构添加新部件，则必须在那里进行更改；这通常仅与内部 DHIS2 团队相关。

提示

查找要编辑的文档来源的最佳方法是在 docs.dhis2.org 网站上找到该文档，然后单击页面顶部的“编辑”图标。

获取文档源¶

为了编辑文档，您需要下载源代码文档到您的计算机。 GitHub使用版本控制系统称为git。有多种获取Git的方法在您的系统上工作，具体取决于您所使用的操作系统使用。可以为Microsoft操作系统提供一个很好的循序渐进指南。已查看 [此处]（https://help.github.com/articles/getting-started-with-github-for-windows）。或者，如果您习惯使用命令行，则可以从[本页]（http://git-scm.com/download/win）下载git 使用Linux，您将需要通过以下方法在系统上安装git 您的包管理器或源代码。一个非常详尽的参考 git的使用方式有多种不同的格式 [此处]（http://git-scm.com/book）。

在系统上安装git后，您需要下载文件来源。只需按照以下步骤操作：

确保您已经安装了git。
在 Windows 系统上，访问相关存储库 URL 并按“在桌面克隆”。如果您使用命令行，则只需输入 git clone git@github.com:dhis2/dhis2-docs.git （请注意，在本例中 dhis2 是存储库的所有者，dhis2-docs 是存储库的名称）
下载过程应开始，所有文档来源文件将下载到您指定的文件夹中。
获得源代码后，请确保为以下内容创建自己的分支编辑。只需执行 git checkout -b mybranch where mybranch 是您要创建的分支的名称。

编辑文件¶

在编写或编辑文档时，您应该注意一些**关键的特定于项目的约定**，本节概述了这些约定。此外，为了方便起见，还实现了几个 Markdown 扩展，并在本文档后面的 Markdown 支持和扩展中进行了演示。

使用图像¶

图像资源应作为相对路径包含在相对于当前文档的子文件夹中。例如对于 content/android/android-event-capture-app.md 章节，图像位于 content/android/resources/images/<rest-of-path> 下，并被引用为 ![](resources/images/<rest-of-path>)

设置图像样式¶

如果您想控制图像的对齐方式和大小，您可以利用我们使用的降价扩展。它允许您在图像定义末尾的大括号中设置宽度、高度和类别等属性。例如：

![](resources/images/maintainence/predictor_sequential.png){ width=50% }

将使你的图像占页面宽度的50%（最好使用百分比以支持多种输出形式），同时

![](resources/images/maintainence/predictor_sequential.png){ .center width=50% }

还将使图像在页面上居中（由于.center 类在 css 中的定义）。

当图像写成这样

批准和接受](resources/images/data_approval/approval_level_steps.png)

即，方括号中带有标题文本，它们将呈现为带有标题的图形。默认情况下，它们居中，并带有居中的斜体标题。

截屏{ #taking-screenshots }¶

对于 DHIS 2 Web 界面的屏幕截图，我们建议使用 Chrome 浏览器，并带有以下两个扩展程序： 1. 窗口调整器。使用它将分辨率设置为 1440x900 2. Fireshot。使用它可以快速创建**可见部分**的快照

如果需要，Fireshot 甚至可以捕获整个页面，即滚动页面。它还可以仅捕获选定区域（但最大宽度应始终为 1440px）

截取 Android 应用程序的屏幕截图时，大小应设置为 360x640。

本地化图像¶

通过将图像的特定语言版本与原始图像一起存储，可支持图像的本地化。文件名应与原始英文版本相同，但应在名称末尾、扩展名之前加上_和语言代码。

例如，如果您想要法语版本 资源/图像/my_screenshot.png 您可以简单地创建法语版本并将其另存为 资源/图像/my_screenshot_fr.png

文档中的链接仍应指向原始图像。当为每种语言构建文档站点时，将识别并使用本地化图像而不是英文原件。

在查看本地化版本的文档时，语言代码是您在 "docs.dhis2.org/"之后看到的 URL 的第一部分。例如，在撰写本文时，我们有 fr、es_419、pt、cs 和 zh.* 。

章节参考¶

为了在文档中提供固定的引用（锚点），我们可以设置一个固定的文本字符串以应用于任何部分。对于我们的 Markdown 处理器，这是通过在带有部分标题的行末尾的大括号中添加哈希 ID 来完成的，例如

## 验证{ #webapi_validation }

要生成数据验证摘要，您可以交互 ...

将 2 级标题 Validation 的部分 ID 设置为“webapi_validation”，然后可以从*任何* html 文件中将其引用为“#webapi_validation”。

注

为了支持从其他文档通过锚引用进行链接，请尽量保持章节 id 的唯一性。例如，如果 "#webapi_validation "在整个文档中都是唯一的，那么您只需使用"链接名`"就可以从文档的任何其他部分引用它。
如果被引用的部分 id 不是唯一的，文档处理器将尝试解析到与该名称 "最接近 "的锚点。当链接文件属于特定版本时，文件处理程序将忽略属于不同版本的锚点。

注意**

我们的文档被编译成网页和完整文档。因此，不建议在文档间引用时包含路径。请使用上文所述的唯一章节 ID，以便在两种文档类型中正确解析链接。

请遵循小写字母和下划线的约定，以便在我们在文档生成过程中拆分文件的情况下创建也可以作为文件名有效的 id。

桌子¶

作为纯共通标记的扩展，我们还支持* GFM表*（用管道|定义），例如：

|表类型|描述
|：-|：-------- |
|商标（HTML）|纯HTML中描述的表|
| Github风味降价（GFM）|用管道描述的表：更易于阅读/编辑，但复杂度有限|

产生如下输出：

桌子类型	描述
通用标记（HTML）	用纯HTML描述的表
Github风味降价（GFM）	用管道描述的表：更易于阅读/编辑，但复杂度有限

对于简单的表，使用它们更方便。它们仅限于一行文本（即，每一行必须在一行上），但是您可以例如使用<br>标签创建换行符，并在必要时有效地拆分单元格中的段落。当您确实需要更多复杂性时，您也可以继续使用HTML表（但您也可以考虑是否存在更好的数据表示方法）。

DHIS 2参考书目¶

DHIS 2文档的降价版本当前不支持书目参考。

处理多语言文档¶

DHIS 2文档已翻译成许多不同的语言包括法语，西班牙语和葡萄牙语。如果你想创建文档的翻译版本或为以下内容之一做出贡献现有翻译，请联系DHIS 2文档团队，网址为本章末尾提供的电子邮件。

将所做的更改提交回GitHub¶

完成文档编辑后，您需要提交将更改提交回 GitHub。在 Windows 下打开命令提示符，在 Linux 下打开 shell 打开命令提示符，并导航到放置文档的文件夹。文件夹。如果您在本地如果您在本地仓库中添加了新文件或文件夹，则需要使用 `git 添加命令将它们添加到源代码树中，并在命令后面加上所添加的文件夹或文件名。请务必在提交时附上说明性注释。

git提交 -米 “改进了有关使用CSV导入组织单位的文档。”

最后，您应该使用git将更改推回到存储库中推送源mybranch，其中“ mybranch”是分支的名称您是在签出文档源时创建的还是碰巧正在努力。为此，您需要提交到存储库所需的权限。做出更改，[您可以发出拉动请求]（https://github.com/dhis2/dhis2-docs/pulls）将它们合并与master分支。您所做的更改将由核心审核文档团队并经过测试以确保它们不会破坏构建，如以及对质量的偏爱。如前所述，您还可以按您对自己的GitHub存储库的更改（如果您无权访问主仓库，并提交合并更改的请求请求。

如果您有任何疑问，或者无法找到可以开始的知识，只需对我们的[实践发展社区]（https://community.dhis2.org/c/development）提出疑问。

Markdown 支持和扩展{ #markdown_support_and_extensions }¶

本节尝试捕获DHIS 2文档支持的降价和扩展，并提供所应用样式的预览。

h3标题¶

h4标题¶

h5标题¶

h6标题¶

文章主体。

水平尺¶

___

---

***

重点¶

这是粗体字

这是斜体文字

~~删除线~~

块引用¶

===“示例”

> 基本楷体引号

> 块引号也可以嵌套...
>> ......通过使用紧挨着的其他大于号......
> > ...或者在箭头之间加上空格。

请注意，嵌套的小引号有一种特殊的样式，有助于显示层次结构。

> 您也可以手动将嵌套样式应用到单个分块引号 { .nested } 中。

===“降价”

```
> 基本块引号

> 块引号也可以嵌套...
>> ......通过使用紧挨着的其他大于号......
> > ...或者在箭头之间加上空格。

请注意，嵌套的小引号有一种特殊的样式，有助于显示层次结构。

> 您也可以手动将嵌套样式应用到单个分块引号 { .nested } 中。
```

码¶

内联代码

内嵌突出显示的代码 var test = 0;

`#!js var test = 0;`

缩进代码

//一些评论
代码的第一行
代码的第二行
代码的第3行

围栏代码“围栏”

示例文本在这里...

语法高亮

var foo = function（bar）{
  返回bar ++;
};

console.log（foo（5））;

排长龙

Buffalo buffalo（从Buffalo市被称为“ buffalo”的动物）[that] Buffalo buffalo buffalo（使城市中的动物欺负）buffalo Buffalo buffalo（正在从该城市中欺负这些动物）。

突出显示特定行

===“渲染”

``` py hl_lines="2 3"
def bubble_sort(items)：
    for i in range(len(items))：
        for j in range(len(items) - 1 - i)：
            if items[j] > items[j + 1]：
                items[j], items[j + 1] = items[j + 1], items[j]
```

===“降价”

````
``` py hl_lines="2 3"
def bubble_sort(items)：
    for i in range(len(items))：
        for j in range(len(items) - 1 - i)：
            if items[j] > items[j + 1]：
                items[j], items[j + 1] = items[j + 1], items[j]
```
````

添加标题

===“渲染”

``` py hl_lines="2 3" title="bubble_sort.py"
def bubble_sort(items)：
    for i in range(len(items))：
        for j in range(len(items) - 1 - i)：
            if items[j] > items[j + 1]：
                items[j], items[j + 1] = items[j + 1], items[j]
```

===“降价”

````
``` py hl_lines="2 3" title="bubble_sort.py"
def bubble_sort(items)：
    for i in range(len(items))：
        for j in range(len(items) - 1 - i)：
            if items[j] > items[j + 1]：
                items[j], items[j + 1] = items[j + 1], items[j]
```
````

清单¶

无序

以 +、- 或 * 开头创建列表
子列表通过缩进2个空格制成：
- 标记字符更改会强制新列表开始：
  - Ac tristique libero volutpat at
  - Facilisis在prenis中的aliquet
```
an indented code block
```
  - Nulla volutpat aliquam velit
  - 很容易！

已订购

Lorem ipsum dolor坐在amet
奉献精英
Massa的整数痣
您可以使用序号...
...或将所有数字保留为1。

以偏移量开始编号？：

富
酒吧

多层次

第一项目
仍然是第一级
1. 第二级
2. 仍然第二
  1. 第三级
```
a block of code at the third level
```
  2. 第三级
3. 再二级
回到第一层
1. 第二
  1. 哦，别这样！

桌子¶

返回参数	描述
冠捷	属性选项组合标识符
聚乙烯	期间标识符
欧	组织单位标识符
权限	权限：“ mayApprove”，“ mayUnapprove”，“ mayAccept”，“ mayUnaccept”和“ mayReadData”（与获得单一批准状态的定义相同）。
州	数据批准状态之一（与获取单个批准状态相同）。
工作组	数据批准工作流标识符

右对齐和居中的列

返回参数	描述
冠捷	属性选项组合标识符
聚乙烯	期间标识符
欧	组织单位标识符
权限	权限：“ mayApprove”，“ mayUnapprove”，“ mayAccept”，“ mayUnaccept”和“ mayReadData”（与获得单一批准状态的定义相同）。
州	数据批准状态之一（与获取单个批准状态相同）。
工作组	数据批准工作流标识符

链接¶

链接文本

带有标题的链接

自动转换的链接https://github.com/dhis2

图片¶

图片以全尺寸显示，最大宽度为100％

![](resources/images/dhis2_screenshots.jpg)

添加标题会自动将其渲染为图形。可以在大括号中添加内联类和样式。

标题](resources/images/dhis2_screenshots.jpg){ .center width=50% }

Youtube¶

YouTube 视频可以以与图像类似的方式嵌入。只需提供 YouTube 嵌入链接而不是图像文件

`` 降价

注意

请务必使用“嵌入”youtube 链接！

与图像一样，添加标题会将视频呈现为图形

![DHIS2：行动信息](https://www.youtube.com/embed/UqXSMaXBtD8)

DHIS2：行动信息

告诫¶

除常规块引用外，还支持以下带有预定义样式的警告。

注意¶

===“注意”

> **注意**
>
>注释包含应考虑的其他信息或
>参考更多信息可能会有所帮助。

===“降价”

```
> **Note**
>
> A note contains additional information which should be considered or a
> reference to more information which may be helpful.
```

小费¶

===“提示”

> **提示**
>
>提示可能是有用的建议，例如如何执行
>更有效地执行特定任务。

===“降价”

```
> **Tip**
>
> A tip can be a useful piece of advice, such as how to perform a
> particular task more efficiently.
```

重要¶

===“重要”

> **重要**
>
>重要信息不容忽视，通常表示
>应用程序所需的内容。

===“降价”

```
> **Important**
>
> Important information should not be ignored, and usually indicates
> something which is required by the application.
```

警告¶

===“注意”

> **注意**
>
>这些部分中包含的信息应谨慎
>考虑，如果不注意，可能会导致
>分析，性能或功能。

===“降价”

```
> **Caution**
>
> Information contained in these sections should be carefully
> considered, and if not heeded, could result in unexpected results in
> analysis, performance, or functionality.
```

警告¶

===“警告”

> **警告**
>
>如果不注意，可能会导致这些部分中包含的信息
>永久性数据丢失或影响系统的整体可用性。

===“降价”

```
> **Warning**
>
> Information contained in these sections, if not heeded, could result
> in permanent data loss or affect the overall usability of the system.
```

工作正在进行中¶

===“正在进行中”

> **进行中**
>
>这些部分中包含的信息将表明这些是我们当前正在处理的问题或错误。

===“降价”

```
> **Work In Progress**
>
> Information contained in these sections, will indicate that these are issues or errors we are currently working on.
```

例¶

===“示例”

> **示例**
>
>一种特别注意示例的方法。
>
>训诫可以包含一个代码块
>
>```js
> var foo = function（bar）{
>返回栏++;
>};
>
> console.log（foo（5））;
>```

===“降价”

```
> **Example**
>
> A way to bring special attention to examples.
>
> Admonitions can include a code blocks
>
> ```js
> var foo = function (bar) {
>   return bar++;
> };
>
> console.log(foo(5));
> ```
```

数学方程¶

MathJax 提供对显示数学内容的支持在浏览器中支持不同符号的数学排版（例如 LaTeX、MathML、AsciiMath)。

块必须包含在单独的行上的\[ ... \]或$$ ... $$或\begin{} ... \end{}中。内联块必须包含在 $...$ 或 $...$ 中。

===“方程式”

\[
指标 = {\frac{BcgVaccinationsUnder1Year}{TargetPopulationUnder1Year}} \times 100
\]

\[3 < 4\]

\开始{对齐}
    p(v_i=1|\mathbf{h}) & = \sigma\left(\sum_j w_{ij}h_j + b_i\right) \\
    p(h_j=1|\mathbf{v}) & = \sigma\left(\sum_i w_{ij}v_i + c_j\right)
\结束{对齐}

\( u \) 的波动方程为

\开始{方程}
  \frac{\partial^2u}{\partial t^2} = c^2\nabla^2u
\end{方程}

其中 \( \nabla^2 \) 是空间拉普拉斯算子， \( c \) 是常数。

这个方程 $p(x|y) = \frac{p(y|x)p(x)}{p(y)}$ 是内联的。

同态 $f$ 是单射的当且仅当它的核只是
单例集合$e_G$，因为否则$\存在a,b\in G$和$a\neq b$使得$f(a)=f(b)$。

===“降价”

```
\[
Indicator = {\frac{BcgVaccinationsUnder1Year}{TargetPopulationUnder1Year}} \times 100
\]

\[3 < 4\]

\begin{align}
    p(v_i=1|\mathbf{h}) & = \sigma\left(\sum_j w_{ij}h_j + b_i\right) \\
    p(h_j=1|\mathbf{v}) & = \sigma\left(\sum_i w_{ij}v_i + c_j\right)
\end{align}

The wave equation for \( u \) is

\begin{equation}
  \frac{\partial^2u}{\partial t^2} = c^2\nabla^2u
\end{equation}

where \( \nabla^2 \) is the spatial Laplacian and \( c \) is constant.

This equation $p(x|y) = \frac{p(y|x)p(x)}{p(y)}$ is inline.

The homomorphism $f$ is injective if and only if its kernel is only the 
singleton set $e_G$, because otherwise $\exists a,b\in G$ with $a\neq b$ such that $f(a)=f(b)$.
```

印刷替代品¶

降价促销	结果
`（tm）`	（Tm值）
`（c）`	（C）
`（r）`	（r）
`c / o`	c / o
`+/-`	±
`->`	->
`<-`	<-
`<-->`	↔
`= / =`	= / =
`1/4 等`	¼等
`第一第二等等`	一二等

下标/上标¶

- 19^日^
- H~2~O

19 ^ th ^
氢₂氧

++插入文字++

标记文字

[脚注]（https://github.com/markdown-it/markdown-it-footnote）¶

脚注1链接[^ first]。

脚注2链接[^ second]。

内联脚注^ [内联脚注的文本]定义。

脚注参考重复[^ second]。

定义清单¶

第一学期：定义1，具有延迟延续。

第二学期带有*内联标记* ：定义2

    {一些代码，定义2的一部分}

定义的第三段2。

键{ #keys }¶

Keys 是一款扩展工具，可让键盘按键的输入和样式设计变得更简单。从语法上讲，Keys 是围绕符号。一个按键或按键组合由 ++ 包围，每个按键用一个 + 分隔。

示例

===“输出” ++ctrl+alt+删除++。

===“降价” ++ctrl+alt+删除++

支持以下关键渲染。

===“修改器”

名称 | 显示 | 别名
--------------- | ----------------- | -------
`alt` | ++alt++ | `left-alt` | ++left-alt++ | `lalt`.
`left-alt` | ++left-alt++ | `lalt`
`right-alt` | ++right-alt++ | `ralt`
`alt-graph` | ++alt-graph++ | `altgr`
`command` | ++command++ | `cmd`
`left-command` | ++left-command++ | `lcommand`, `lcmd`, `left-cmd`
`right-command` | ++right-command++ | `rcommand`, `rcmd`, `right-cmd`
`control` | ++control++ | `ctrl`.
| ++left-control++ | `lcontrol`, `lctrl`, `left-ctrl`.
| ++right-control++ | `rcontrol`, `rctrl`, `right-ctrl
`function` | ++function++ | `fn`
`meta` | ++meta++ | `left-meta` | ++function++ | `fn`.
`left-meta` | ++left-meta++ | `lmeta`.
`right-meta` | ++right-meta++ | `rmeta`
`option` | ++option++ | `opt`
`left-option` | ++left-option++ | `loption`, `lopt`, `left-opt`
`right-option` | ++right-option++ | `roption`, `ropt`, `right-opt`
`shift` | ++shift++ | `left-shift`.
`left-shift` | ++left-shift++ | `lshift`.
| ++right-shift++ | `rshift`.
`super` | ++super++ | `left-super`.
`left-super` | ++left-super++ | `lsuper`
| ++right-super++ | `rsuper`.
| ++windows++ | `win
`left-windows` | ++left-windows++ | `lwindows`, `left-win`, `lwin`
`right-windows` | ++right-windows++ | `rwindows`, `right-win`, `rwin`

===“功能”

名称 |显示|别名
-----| -------- | --------
`f1` | ++f1++ |
`f2` | ++f2++ |
`f3` | ++f3++ |
`f4` | ++f4++ |
`f5` | ++f5++ |
`f6` | ++f6++ |
`f7` | ++f7++ |
`f8` | ++f8++ |
`f9` | ++f9++ |
`f10` | ++f10++ |
`f11` | ++f11++ |
`f12` | ++f12++ |
`f13` | ++f13++ |
`f14` | ++f14++ |
`f15` | ++f15++ |
`f16` | ++f16++ |
`f17` | ++f17++ |
`f18` | ++f18++ |
`f19` | ++f19++ |
`f20` | ++f20++ |
`f21` | ++f21++ |
`f22` | ++f22++ |
`f23` | ++f23++ |
`f24` | ++f24++ |

===“字母数字”

名称 |显示|别名
-------- | --------- | --------
`0` | ++0++ |
`1` | ++1++ |
`2` | ++2++ |
`3` | ++3++ |
`4` | ++4++ |
`5` | ++5++ |
`6` | ++6++ |
`7` | ++7++ |
`8` | ++8++ |
`9` | ++9++ |
`a` | ++a++ |
`b` | ++b++ |
`c` | ++c++ |
`d` | ++d++ |
`e` | ++e++ |
`f` | ++f++ |
`g` | ++g++ |
`h` | ++h++ |
`我` | ++我++ |
`j` | ++j++ |
`k` | ++k++ |
`l` | ++l++ |
`m` | ++m++ |
`n` | ++n++ |
`o` | ++o++ |
`p` | ++p++ |
`q` | ++q++ |
`r` | ++r++ |
`s` | ++s++ |
`t` | ++t++ |
`你` | ++你++ |
`v` | ++v++ |
`w` | ++w++ |
`x` | ++x++ |
`y` | ++y++ |
`z` | ++z++ |
`空间` | ++空间++ | `spc`

===“标点符号”

名称 | 显示 | 别名
--------------- | ----------------- | -------
`backslash` | ++backslash++ | `bar` | ++bar++ | `pipe`.
`bar` | ++bar++ | `pipe`.
`brace-left` | ++brace-left++ | `open-brace`.
`brace-right` | ++brace-right++ | `close-bracket`.
`bracket-left` | ++bracket-left++ | `open-bracket` `关闭括号
`bracket-right` | ++bracket-right++ | `close-bracket` 闭合括号
`colon` | ++colon++ | `commons
`colon` | ++colon++ |`comma` | ++comma++ |`double-quote
双引号 | +++ 双引号++ | 双引号
`equal` | ++equal++ | `exclam` | ++exclam++ | `xclam`.
`exclam` | ++exclam++ | `exclamation`.
`grave` | ++grave++ | `grave-accent`.
`greater` | ++greater++ | `greater-than`, `gt`
`less` | ++less++ | `less-than`, `lt`
`minus` | ++minus++ | `hyphen`.
`period` | ++period++ | `plus` | ++plus++ | `hyphen`.
`plus` | ++plus++ | `question` | ++question++ | `question`.
`question` | ++question++ | `question-mark` `分号
`semicolon` | ++semicolon++ | `单引号
单引号
斜线
`tilde` | ++tilde++ | `underscore` | ++underscore++ | `underscore`.
`UNDERSCORE` | ++UNDERSCORE++ | `UNDERSCORE`.

===“导航”

名称 | 显示 | 别名
------------- | --------------- | -------
向上箭头
`arrow-down` | ++arrow-down++ | `down`.
`arrow-left` | ++arrow-left++ | `left` 左
| ++arrow-right++ | `right` `箭头向右
| ++page-up++ | `prior`,`page-up`,`pg-up`。
`page-down` | ++page-down++ | `next`, `page-dn`, `pg-dn`
`home` | ++home++ | `end` | ++end++ | `nd`.
`end` | ++end++ | `tab` | ++tab++ | `tab`.
| ++tab++ | `tabulator` `tab

===“编辑”

名称 |显示|别名
----------- | ------------- | --------
`退格键` | ++退格键++ | `返回`, `bksp`
`删除` | ++删除++ | `德尔`
`插入` | ++插入++ | `ins`

===“行动”

名称 |显示|别名
-------------- | -----------------| --------
`打破` | ++中断++ | `取消`
`大写锁定` | ++大写锁定++ | `资本`, `cplk`
`清除` | ++清除++ | `clr`
`弹出` | ++弹出++ |
`输入` | ++输入++ | `返回`
`逃脱` | ++逃脱++ | `esc`
`帮助` | ++帮助++ |
`打印屏幕` | ++打印屏幕++ | `prtsc`
`滚动锁定` | ++滚动锁++ | `滚动`

===“数字键盘”

名称 | 显示 | 别名
--------------- | ----------------- | -------
`num0` | ++num0++ | `num1` | ++num1++ | `num1`.
`num1` | ++num1++ | `num2` | ++num2++ | `num2
`num2` | ++num2++ | `num3` | ++num3++ | `num3
`num3` | ++num3++ | `num4` | ++num4++ | `num4`.
`num4` | ++num4++ | `num5` | ++num5++ | `num5`.
`num5` | ++num5++ | `num6` | ++num6++ | `num6`.
| ++num6++ | `num7
`num7` | ++num7++ | `num8` | ++num8++ | `num8` | ++num8++ |
`num8` | ++num8++ | `num9` | ++num9++ | `num9` | ++num9++ |
| ++num9++ | `num9
| ++num8++ | `num9` | ++num9++ | `num-asterisk` | ++num-asterisk++ | `multiply`.
`num-clear` | ++num-clear++ | `num-delete` | ++num-delete++ | `num-delete`.
`num-delete` | ++num-delete++ | `num-del` `num-equal` | ++num-equal++ | `num-equal
`num-equal` | ++num-equal++ |`num-lock
| ++num-lock++ | `numlk`, `numlock`.
`num-minus` | ++num-minus++ | `subtract`.
`num-plus` | ++num-plus++ | `add`.
`num-separator` | ++num-separator++ | `decimal`, `separator`.
`num-slash` | ++num-slash++ | `divide`.
`num-enter` | ++num-enter++ | `divide`.

===“额外的钥匙”

名称 | 显示 | 别名
------------------- | --------------------- | -------
`backtab` | ++backtab++ | `bktab`
`browser-back` | ++browser-back++ | `browser-favorites` | ++browser-favorites
| ++browser-favorites++ | `favorites` `浏览器收藏夹
| ++browser-forward++ | `forward` `浏览器向前
`browser-home` | ++browser-home++ | `browser-refresh`.
| ++browser-refresh++ | `refresh` `浏览器刷新
浏览器搜索
`browser-stop` | ++browser-stop++ |`copy`.
复制
`context-menu` | ++context-menu++ | `apps`, `menu`
| ++fingerprint++ | `fingerprint`.
`mail` | ++mail++ | `launch-mail`.
| ++media++ | `launch-media` `媒体
| ++media-next-track++ | `next-track``media-next-track
`media-pause` | ++media-pause++ | `pause`.
`media-play` | ++media-play++ | `play`
`media-play-pause` | ++media-play-pause++ | `play-pause`
`media-prev-track` | ++media-prev-track++ | `prev-track`.
`media-stop` | ++media-stop++ | `stop`...
`power` | ++power++ | `print` | ++text
`print` | ++print++ | `reset` | ++reset++ | `media-stop
复位
`select` | ++select++ | `sleep` | ++sleep++ | `sleep`.
`sleep` | ++sleep++ | `volume-down` | ++volume-down
`volume-down` | ++volume-down++ | `vol-down` | `vol-down
`volume-mute` | ++volume-mute++ | `mute`.
`volume-up` | ++volume-up++ | `vol-up` ` 放大
| ++zoom++ |`zoom

===“鼠标”

名称 |显示|别名
---------------- | ----------------- | --------
`左键` | ++左键++ | `左按钮`
`中键` | ++中键++ | `m按钮`
`右键` | ++右键++ | `r按钮`
`x-button1` | ++x-button1++ | `xbutton1`
`x-button2` | ++x-button2++ | `xbutton2`

表情符号¶

通过输入冒号包围的表情符号名称，可以支持几组表情符号：例如：smile：。以下是常见集合的列表，当前不支持未渲染的集合。

===“人”

:bowtie: :smile: :laughing: :blush: :smiley: :relaxed: :smirk: :heart_eyes: :kissing_heart: :kissing_closed_eyes: :flushed: :relieved: :satisfied: :grin: :wink: :stuck_out_tongue_winking_eye: :stuck_out_tongue_closed_eyes: :grinning: :kissing: :kissing_smiling_eyes: :stuck_out_tongue: :sleeping: :worried: :frowning: :anguished: :open_mouth: :grimacing: :confused: :hushed: :expressionless: :unamused: :sweat_smile: :sweat: :disappointed_relieved: :weary: :pensive: :disappointed: :confounded: :fearful: :cold_sweat: :persevere: :cry: :sob: :joy: :astonished: :scream: :neckbeard: :tired_face: :angry: :rage: :triumph: :sleepy: :yum: :mask: :sunglasses: :dizzy_face: :imp: :smiling_imp: :neutral_face: :no_mouth: :innocent: :alien: :yellow_heart: :blue_heart: :purple_heart: :heart: :green_heart: :broken_heart: :heartbeat: :heartpulse: :two_hearts: :revolving_hearts: :cupid: :sparkling_heart: :sparkles: :star: :star2: :dizzy: :boom: :collision: :anger: :exclamation: :question: :grey_exclamation: :grey_question: :zzz: :dash: :sweat_drops: :notes: :musical_note: :fire: :hankey: :poop: :shit: :+1: :thumbsup: :-1: :thumbsdown: :ok_hand: :punch: :facepunch: :fist: :v: :wave: :hand: :raised_hand: :open_hands: :point_up: :point_down: :point_left: :point_right: :raised_hands: :pray: :point_up_2: :clap: :muscle: :metal: :fu: :walking: :runner: :running: :couple: :family: :two_men_holding_hands: :two_women_holding_hands: :dancer: :dancers: :ok_woman: :no_good: :information_desk_person: :raising_hand: :bride_with_veil: :person_with_pouting_face: :person_frowning: :bow: :couplekiss: :couple_with_heart: :massage: :haircut: :nail_care: :boy: :girl: :woman: :man: :baby: :older_woman: :older_man: :person_with_blond_hair: :man_with_gua_pi_mao: :man_with_turban: :construction_worker: :cop: :angel: :princess: :smiley_cat: :smile_cat: :heart_eyes_cat: :kissing_cat: :smirk_cat: :scream_cat: :crying_cat_face: :joy_cat: :pouting_cat: :japanese_ogre: :japanese_goblin: :see_no_evil: :hear_no_evil: :speak_no_evil: :guardsman: :skull: :feet: :lips: :kiss: :droplet: :ear: :eyes: :nose: :tongue: :love_letter: :bust_in_silhouette: :busts_in_silhouette: :speech_balloon: :thought_balloon:

===“自然”

:sunny: :umbrella: :cloud: :snowflake: :snowman: :zap: :cyclone: :foggy: :ocean: :cat: :dog: :mouse: :hamster: :rabbit: :wolf: :frog: :tiger: :koala: :bear: :pig: :pig_nose: :cow: :boar: :monkey_face: :monkey: :horse: :racehorse: :camel: :sheep: :elephant: :panda_face: :snake: :bird: :baby_chick: :hatched_chick: :hatching_chick: :chicken: :penguin: :turtle: :bug: :honeybee: :ant: :beetle: :snail: :octopus: :tropical_fish: :fish: :whale: :whale2: :dolphin: :cow2: :ram: :rat: :water_buffalo: :tiger2: :rabbit2: :dragon: :goat: :rooster: :dog2: :pig2: :mouse2: :ox: :dragon_face: :blowfish: :crocodile: :dromedary_camel: :leopard: :cat2: :poodle: :paw_prints: :bouquet: :cherry_blossom: :tulip: :four_leaf_clover: :rose: :sunflower: :hibiscus: :maple_leaf: :leaves: :fallen_leaf: :herb: :mushroom: :cactus: :palm_tree: :evergreen_tree: :deciduous_tree: :chestnut: :seedling: :blossom: :ear_of_rice: :shell: :globe_with_meridians: :sun_with_face: :full_moon_with_face: :new_moon_with_face: :new_moon: :waxing_crescent_moon: :first_quarter_moon: :waxing_gibbous_moon: :full_moon: :waning_gibbous_moon: :last_quarter_moon: :waning_crescent_moon: :last_quarter_moon_with_face: :first_quarter_moon_with_face: :moon: :earth_africa: :earth_americas: :earth_asia: :volcano: :milky_way: :partly_sunny: :octocat: :squirrel:

===“对象”

:bamboo: :gift_heart: :dolls: :school_satchel: :mortar_board: :flags: :fireworks: :sparkler: :wind_chime: :rice_scene: :jack_o_lantern: :ghost: :santa: :christmas_tree: :gift: :bell: :no_bell: :tanabata_tree: :tada: :confetti_ball: :balloon: :crystal_ball: :cd: :dvd: :floppy_disk: :camera: :video_camera: :movie_camera: :computer: :tv: :iphone: :phone: :telephone: :telephone_receiver: :pager: :fax: :minidisc: :vhs: :sound: :speaker: :mute: :loudspeaker: :mega: :hourglass: :hourglass_flowing_sand: :alarm_clock: :watch: :radio: :satellite: :loop: :mag: :mag_right: :unlock: :lock: :lock_with_ink_pen: :closed_lock_with_key: :key: :bulb: :flashlight: :high_brightness: :low_brightness: :electric_plug: :battery: :calling: :email: :mailbox: :postbox: :bath: :bathtub: :shower: :toilet: :wrench: :nut_and_bolt: :hammer: :seat: :moneybag: :yen: :dollar: :pound: :euro: :credit_card: :money_with_wings: :e-mail: :inbox_tray: :outbox_tray: :envelope: :incoming_envelope: :postal_horn: :mailbox_closed: :mailbox_with_mail: :mailbox_with_no_mail: :door: :smoking: :bomb: :gun: :hocho: :pill: :syringe: :page_facing_up: :page_with_curl: :bookmark_tabs: :bar_chart: :chart_with_upwards_trend: :chart_with_downwards_trend: :scroll: :clipboard: :calendar: :date: :card_index: :file_folder: :open_file_folder: :scissors: :pushpin: :paperclip: :black_nib: :pencil2: :straight_ruler: :triangular_ruler: :closed_book: :green_book: :blue_book: :orange_book: :notebook: :notebook_with_decorative_cover: :ledger: :books: :bookmark: :name_badge: :microscope: :telescope: :newspaper: :football: :basketball: :soccer: :baseball: :tennis: :8ball: :rugby_football: :bowling: :golf: :mountain_bicyclist: :bicyclist: :horse_racing: :snowboarder: :swimmer: :surfer: :ski: :spades: :hearts: :clubs: :diamonds: :gem: :ring: :trophy: :musical_score: :musical_keyboard: :violin: :space_invader: :video_game: :black_joker: :flower_playing_cards: :game_die: :dart: :mahjong: :clapper: :memo: :pencil: :book: :art: :microphone: :headphones: :trumpet: :saxophone: :guitar: :shoe: :sandal: :high_heel: :lipstick: :boot: :shirt: :tshirt: :necktie: :womans_clothes: :dress: :running_shirt_with_sash: :jeans: :kimono: :bikini: :ribbon: :tophat: :crown: :womans_hat: :mans_shoe: :closed_umbrella: :briefcase: :handbag: :pouch: :purse: :eyeglasses: :fishing_pole_and_fish: :coffee: :tea: :sake: :baby_bottle: :beer: :beers: :cocktail: :tropical_drink: :wine_glass: :fork_and_knife: :pizza: :hamburger: :fries: :poultry_leg: :meat_on_bone: :spaghetti: :curry: :fried_shrimp: :bento: :sushi: :fish_cake: :rice_ball: :rice_cracker: :rice: :ramen: :stew: :oden: :dango: :egg: :bread: :doughnut: :custard: :icecream: :ice_cream: :shaved_ice: :birthday: :cake: :cookie: :chocolate_bar: :candy: :lollipop: :honey_pot: :apple: :green_apple: :tangerine: :lemon: :cherries: :grapes: :watermelon: :strawberry: :peach: :melon: :banana: :pear: :pineapple: :sweet_potato: :eggplant: :tomato: :corn:

===“地点”

：house：：house_with_garden：：school：：office：：post_office：：医院：：bank：：convenience_store：：love_hotel：：hotel：：wedding：：church：：department_store：：european_post_office：：city_sunrise：：city_sunset：：japanese_castle ：：european_castle：：tent：：factory：：tokyo_tower：：japan：：mount_fuji：：sunrise_over_mountains：：sunrise：：stars：：statue_of_liberty：：bridge_at_night：：carousel_horse：：rainbow：：ferris_wheel：：fountain：：roller_co轮船：：speedboat：：boat：：sailboat：：rowboat：：anchor：：rocket：：planeplane：：helicopter：：steam_locomotive：：tram：：mountain_railway：：bike：：aerial_tramway：：suspension_railway：：mountain_cableway：：tractor： ：blue_car：：oncoming_automobile：：car：：red_car：：taxi：：oncoming_taxi：：articulated_lorry：：bus：：oncoming_bus：：rotating_light：：police_car：：oncoming_police_car：：fire_engine：：ambulance：：minibus：：truck：：train ：：station：：train2：：bullettrain_front：：bullettrain_side：：light_rail：：monorail：：railway_car：：trolleybus：：ticket：：fuelpum p：：vertical_traffic_light：：traffic_light：：warning：：construction：：beginner：：atm：：slot_machine：：busstop：：barber：：hotsprings：：checkered_flag：：crossed_flags：：izakaya_lantern：：moyai：：circus_tent：：performing_arts： ：round_pushpin：：triangular_flag_on_post：：jp：：kr：：cn：：us：：fr：：es：：it：：ru：：gb：：uk：：de：

===“符号”

:one: :two: :three: :four: :five: :six: :seven: :eight: :nine: :keycap_ten: :1234: :zero: :hash: :symbols: :arrow_backward: :arrow_down: :arrow_forward: :arrow_left: :capital_abcd: :abcd: :abc: :arrow_lower_left: :arrow_lower_right: :arrow_right: :arrow_up: :arrow_upper_left: :arrow_upper_right: :arrow_double_down: :arrow_double_up: :arrow_down_small: :arrow_heading_down: :arrow_heading_up: :leftwards_arrow_with_hook: :arrow_right_hook: :left_right_arrow: :arrow_up_down: :arrow_up_small: :arrows_clockwise: :arrows_counterclockwise: :rewind: :fast_forward: :information_source: :ok: :twisted_rightwards_arrows: :repeat: :repeat_one: :new: :top: :up: :cool: :free: :ng: :cinema: :koko: :signal_strength: :u5272: :u5408: :u55b6: :u6307: :u6708: :u6709: :u6e80: :u7121: :u7533: :u7a7a: :u7981: :sa: :restroom: :mens: :womens: :baby_symbol: :no_smoking: :parking: :wheelchair: :metro: :baggage_claim: :accept: :wc: :potable_water: :put_litter_in_its_place: :secret: :congratulations: :m: :passport_control: :left_luggage: :customs: :ideograph_advantage: :cl: :sos: :id: :no_entry_sign: :underage: :no_mobile_phones: :do_not_litter: :non-potable_water: :no_bicycles: :no_pedestrians: :children_crossing: :no_entry: :eight_spoked_asterisk: :eight_pointed_black_star: :heart_decoration: :vs: :vibration_mode: :mobile_phone_off: :chart: :currency_exchange: :aries: :taurus: :gemini: :cancer: :leo: :virgo: :libra: :scorpius: :sagittarius: :capricorn: :aquarius: :pisces: :ophiuchus: :six_pointed_star: :negative_squared_cross_mark: :a: :b: :ab: :o2: :diamond_shape_with_a_dot_inside: :recycle: :end: :on: :soon: :clock1: :clock130: :clock10: :clock1030: :clock11: :clock1130: :clock12: :clock1230: :clock2: :clock230: :clock3: :clock330: :clock4: :clock430: :clock5: :clock530: :clock6: :clock630: :clock7: :clock730: :clock8: :clock830: :clock9: :clock930: :heavy_dollar_sign: :copyright: :registered: :tm: :x: :heavy_exclamation_mark: :bangbang: :interrobang: :o: :heavy_multiplication_x: :heavy_plus_sign: :heavy_minus_sign: :heavy_division_sign: :white_flower: :100: :heavy_check_mark: :ballot_box_with_check: :radio_button: :link: :curly_loop: :wavy_dash: :part_alternation_mark: :trident: :black_square: :white_square: :white_check_mark: :black_square_button: :white_square_button: :black_circle: :white_circle: :red_circle: :large_blue_circle: :large_blue_diamond: :large_orange_diamond: :small_blue_diamond: :small_orange_diamond: :small_red_triangle: :small_red_triangle_down: :shipit:

美人鱼¶

Mermaid.js 现在原生支持图表。

流程图¶

流程图是表示工作流程或流程的图表。步骤被渲染为各种节点并通过边连接，描述必要的步骤顺序：

===“示例”

``美人鱼
图LR
A[开始] --> B{错误？};
B -->|是| C[嗯...]；
C --> D[调试];
D --> B；
B ---->|否| E[耶！]；
````

===“降价”

```

    ``` mermaid
    graph LR
    A[Start] --> B{Error?};
    B -->|Yes| C[Hmm...];
    C --> D[Debug];
    D --> B;
    B ---->|No| E[Yay!];
    ```

```

序列图¶

序列图将特定场景描述为顺序交互多个对象或参与者之间，包括交换的消息这些演员之间：

===“示例”

``` mermaid
%%{init: {'mirrorActors': false } }%%

sequenceDiagram

    autonumber
    participant G as package URL<br><br>(github/S3)
    participant M as metatran
    participant T as transifex
    participant F as filesystem<br><br>(path)
    G->>M: package file 
    T->>M: pull latest translation strings
    opt 
        note over M: swap base language
    end

    opt 
        note over M: include/exclude languages
    end
    M->>+F: New package file
```

===“降价”

```
    ``` mermaid
    %%{init: {'mirrorActors': false } }%%

    sequenceDiagram

        autonumber
        participant G as package URL<br><br>(github/S3)
        participant M as metatran
        participant T as transifex
        participant F as filesystem<br><br>(path)
        G->>M: package file 
        T->>M: pull latest translation strings
        opt 
            note over M: swap base language
        end

        opt 
            note over M: include/exclude languages
        end
        M->>+F: New package file
    ```
```

git 图表¶

Git graphs 提供了各个分支上 git 提交和 git 操作的图形表示。

===“示例”

``` mermaid
%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'gitGraph': {
'showBranches': true, 
'showCommitLabel':false, 
'mainBranchName': 'master'}} 
}%%

gitGraph
    commit
    commit
    branch "2.39"
    checkout "2.39"
    commit
    checkout master
    commit
    checkout "2.39"
    branch "patch/2.39.0"
    checkout "patch/2.39.0"
    commit
    checkout master
    commit
    checkout "2.39"
    commit
    checkout "patch/2.39.0"
    commit tag: "2.39.0"
    checkout master
    commit
    checkout "2.39"
    commit
    commit
    checkout "master"
    commit
    checkout "2.39"
    branch "patch/2.39.1"
    checkout "patch/2.39.1"
    commit
    commit tag: "2.39.1"
    checkout "2.39"
    commit
    checkout "patch/2.39.1"
    branch "hotfix 2.39.1.1"
    commit tag: "2.39.1.1"
```

===“降价”

```
    ``` mermaid
    %%{init: { 'logLevel': 'debug', 'theme': 'dark', 'gitGraph': {
    'showBranches': true, 
    'showCommitLabel':false, 
    'mainBranchName': 'master'}} 
    }%%

    gitGraph
        commit
        commit
        branch "2.39"
        checkout "2.39"
        commit
        checkout master
        commit
        checkout "2.39"
        branch "patch/2.39.0"
        checkout "patch/2.39.0"
        commit
        checkout master
        commit
        checkout "2.39"
        commit
        checkout "patch/2.39.0"
        commit tag: "2.39.0"
        checkout master
        commit
        checkout "2.39"
        commit
        commit
        checkout "master"
        commit
        checkout "2.39"
        branch "patch/2.39.1"
        checkout "patch/2.39.1"
        commit
        commit tag: "2.39.1"
        checkout "2.39"
        commit
        checkout "patch/2.39.1"
        branch "hotfix 2.39.1.1"
        commit tag: "2.39.1.1"
    ```

```

脚注**可以加价**

和多个段落。 ↩
脚注文字。 ↩