文档管理中心
服务分发小艺开放平台合作协议与补充接口文档markdown语法规范

markdown语法规范

标准语法

标题

使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。

示例:

收起
自动换行
深色代码主题
复制
  1. # 一级标题
  2. ## 二级标题
  3. ### 三级标题
  4. #### 四级标题
  5. ##### 五级标题
  6. ###### 六级标题

备注:当前单框小艺中不支持使用 = 和 - 标记一级和二级标题。

段落

参考标准语法,段落换行可以直接使用换行符,段落之间通过空行分割即可。

示例:

收起
自动换行
深色代码主题
复制
  1. 这是第一个段落
  2. 这是第二个段落

列表

参考标准语法即可,支持有序和无序列表两种,列表中暂时不支持嵌套表格、代码块、引用等语法。

收起
自动换行
深色代码主题
复制
  1. // 有序列表
  2. 1. First item
  3. 2. Second item
  4. 3. Third item
  5. 4. Fourth item
  6. // 无序列表
  7. - First item
  8. - Second item
  9. - Third item
  10. - Fourth item
  11. // 无序列表
  12. * First item
  13. * Second item
  14. * Third item
  15. * Fourth item
  16. // 无序列表
  17. + First item
  18. + Second item
  19. + Third item
  20. + Fourth item

表格

要添加表,请使用一个或多个连字符(---)创建每列的标题,并使用管道(|)分隔每列。您可以选择在表的任一端添加管道,具体参考GFM语法规范。

示例:

收起
自动换行
深色代码主题
复制
  1. | Syntax | Description |
  2. | - | - |
  3. | Header | Title |
  4. | Paragraph | Text |

引用

Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号,目前暂时不支持引用块嵌套。

示例:

收起
自动换行
深色代码主题
复制
  1. > 区块引用
  2. > 菜鸟教程
  3. > 学的不仅是技术更是梦想

分割线

Markdown 支持三种方式创建水平分割线,使用三个连字符、或三个星号,或这三个下划线。

示例:

收起
自动换行
深色代码主题
复制
  1. - - -
  2. * * *
  3. _ _ _

图片及扩展语法

支持markdown中标准语法,支持直接引用网络图片。

示例:

收起
自动换行
深色代码主题
复制
  1. ![alt](http://example.com/1.png)
  2. ![alt](http://example.com/1.png "图片标题")

关于图片扩展,标准 Markdown 不支持直接控制图片尺寸,因此我们做了如下扩展:

  • 支持在URL中添加查询img-fit参数设置图片是块图片还是行内图片;
  • 支持在alt 设置图片是块图片还是行内图片(适用于无法在图片URL上追加参数场景);
  • 如果图片URL或者alt上没有设置img-fit参数,则会根据图片原始高度自适应,如果图片高度大于3倍行高,则按照块图片处理,否则按照行内图片处理。

示例1:

收起
自动换行
深色代码主题
复制
  1. // 图片自适应
  2. ![alt](http://example.com/1.png?img-fit=none)
  3. // 强制图片显示在一行内,常用于小图标
  4. ![alt](http://example.com/1.png?img-fit=inline)
  5. // 强制图片独占一行,常用于大图
  6. ![alt](http://example.com/1.png?img-fit=block)

示例2:

收起
自动换行
深色代码主题
复制
  1. // 图片自适应: 图片高度按照原始宽高处理
  2. ![alt{imgFit:none}](http://example.com/1.png)
  3. // 强制图片显示在一行内,常用于小图标
  4. ![{imgFit:inline}](http://example.com/1.png)
  5. // 强制图片独占一行,常用于大图
  6. ![alt{imgFit:block}]](http://example.com/1.png)

显示效果如下,第一个红框是行内图片,第二个则是块图片。

文本

支持文本中使用粗体、斜体和删除线,和GFM语法保持一致。

  • 粗体语法:即字体加粗,使用两个星号或两个下划线包围文字
  • 斜体语法:使用一个星号或一个下划线 包围文字
  • 粗斜体组合:使用三个星号或三个下划线 包围文字
  • 删除线:使用两个~包围文字

示例如下:

收起
自动换行
深色代码主题
复制
  1. // 粗体
  2. 这是**粗体文字**使用星号
  3. 这是__粗体文字__使用下划线
  4. // 斜体
  5. 这是*斜体文字*使用星号
  6. 这是_斜体文字_使用下划线
  7. // 粗斜体
  8. *斜体文本*
  9. _斜体文本_
  10. **粗体文本**
  11. __粗体文本__
  12. ***粗斜体文本***
  13. ___粗斜体文本___
  14. // 删除线
  15. ~~BAIDU.COM~~

链接

参考标准语法,示例如下,链接中支持嵌套小图标

收起
自动换行
深色代码主题
复制
  1. [链接名称](链接地址)
  2. [链接名称![alt](http://example/icon.png)](链接地址)

换行

在一行的末尾直接按回车键,即可创建一个换行,当然也可以直接使用<br>标签即可。

代码块

支持围栏代码块,即使用反引号 (```) 包裹代码内容;注意:不支持的每一行缩进至少四个空格或一个制表符创建代码块 。

收起
自动换行
深色代码主题
复制
  1. \`\`\`
  2. git status
  3. git add
  4. git commit
  5. \`\`\`

行内函数

参考标准规范,在段落上的一个函数或片段的代码可以用一个反引号把它包起来(`)。

收起
自动换行
深色代码主题
复制
  1. `printf()` 函数

块公式

公式语法和业界稍微不同,语法如下:

  • 使用一个$包裹,但是$必须独立占一行;
  • 使用两个$包裹,但是$$必须独立占一行;
  • 使用\[和\]包裹,且语法必须独占一行。

示例:

收起
自动换行
深色代码主题
复制
  1. $
  2. a=b+c
  3. $
  4. $$
  5. a=b+c
  6. $$
  7. \[
  8. a=b+c
  9. \]
  10. // 下面语法会被当做行内公式,此处和业界规范稍有差异
  11. 这是一段公式$$a=b+c$$

行内公式

  • 使用一个$包裹,且$前后无换行符;
  • 使用两个$包裹,且$$前后无换行符;
  • 使用\[和\]包裹,且前后无换行符;
  • 使用\(和\)包裹,且前后无换行符;

示例:

收起
自动换行
深色代码主题
复制
  1. 示例1$x^2 + (y - 3)^2 = 4$
  2. 示例2$$x^2 + (y - 3)^2 = 4$$
  3. 示例3:\[ x^2 + (y - 3)^2 = 4 \]
  4. 示例4:\( x^2 + (y - 3)^2 = 4 \)

为了兼容业界写法,行内公式使用单个(不要有换行符),块公式使用两个包裹($要独占一行,这样也方便阅读)。

扩展语法

行内HTML(参考源、span标签)

当前支持在段落使用部分HTML标签实现字体大小、颜色等控制,支持的标签如下:

  • strong:字体加粗;
  • em:斜体;
  • br:强制换行符;
  • rsup: 参考源角标;
  • span:支持设置style属性,支持属性:color、font-size、font-style、font-weight、line-height、text-decoration-line和text-decoration-color;

Span的支持的style属性列表:

展开

属性名

示例

属性取值

作用

color

color:#dddeee

支持HEX和RGAB等颜色

设置字体颜色

font-size

font-size:16

  

字体大小,支持vp和px单位,没有单位是默认是vp

font-style

font-style:italic

normal和italic

字体斜体

line-height

line-height:20

  

设置行高

text-decoration-line

text-decoration-line:underline

取值范围:underline, overline, line-through

删除上划线、中划线和下划线

text-decoration-color

text-decoration-color:#EEEEEE

取值范围:HEX和RGBA

颜色

示例:

收起
自动换行
深色代码主题
复制
  1. <strong>HUAWEI Mate 80 Pro 16GB+512GB 曜石黑</strong>的价格是 <span style="color:rgb(207, 10, 44);font-size:20">¥6999 </span> <br>
  2. 操作系统 <br> HarmonyOS 6.0 <rsup>1</rsup>
  3. 屏幕类型 <br> OLED支持1-120Hz LTPO自适应刷新率1440Hz高频PWM调光300Hz触控采样率<rsup>2</rsup> <br> <em>可使用的内存容量小于此值因为手机软件占用部分空间。</em>

展示效果图:

在 服务分发 中进行搜索
请输入您想要搜索的关键词