目录

markdown语法规范

标准语法

[h2]标题

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

示例:

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

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

[h2]段落

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

示例:

这是第一个段落

这是第二个段落

[h2]列表

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

// 有序列表
1. First item
2. Second item
3. Third item
4. Fourth item

// 无序列表
- First item
- Second item
- Third item
- Fourth item

// 无序列表
* First item
* Second item
* Third item
* Fourth item

// 无序列表
+ First item
+ Second item
+ Third item
+ Fourth item

[h2]表格

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

示例:

| Syntax      | Description |
| - | - |
| Header      | Title       |
| Paragraph   | Text        |

[h2]引用

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

示例:

> 区块引用
> 菜鸟教程
> 学的不仅是技术更是梦想

[h2]分割线

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

示例:

- - -
* * *
_ _ _

[h2]图片及扩展语法

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

示例:

![alt](http://example.com/1.png)

![alt](http://example.com/1.png "图片标题")

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

示例1:

// 图片自适应 
![alt](http://example.com/1.png?img-fit=none)

// 强制图片显示在一行内,常用于小图标
![alt](http://example.com/1.png?img-fit=inline)

// 强制图片独占一行,常用于大图
![alt](http://example.com/1.png?img-fit=block)

示例2:

// 图片自适应: 图片高度按照原始宽高处理 
![alt{imgFit:none}](http://example.com/1.png)

// 强制图片显示在一行内,常用于小图标
![{imgFit:inline}](http://example.com/1.png)

// 强制图片独占一行,常用于大图
![alt{imgFit:block}]](http://example.com/1.png)

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

[h2]文本

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

示例如下:

// 粗体
这是**粗体文字**使用星号
这是__粗体文字__使用下划线

// 斜体
这是*斜体文字*使用星号
这是_斜体文字_使用下划线

// 粗斜体
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

// 删除线
~~BAIDU.COM~~

[h2]链接

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

[链接名称](链接地址)
[链接名称![alt](http://example/icon.png)](链接地址)

[h2]换行

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

[h2]代码块

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

   \`\`\`
    git status
    git add
    git commit
    \`\`\`

[h2]行内函数

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

`printf()` 函数

[h2]块公式

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

示例:

$
a=b+c
$

$$
a=b+c
$$

\[
a=b+c
\]

// 下面语法会被当做行内公式,此处和业界规范稍有差异

这是一段公式$$a=b+c$$

[h2]行内公式

示例:

示例1:$x^2 + (y - 3)^2 = 4$
示例2:$$x^2 + (y - 3)^2 = 4$$
示例3:\[ x^2 + (y - 3)^2 = 4 \]
示例4:\( x^2 + (y - 3)^2 = 4 \)

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

扩展语法

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

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

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

颜色

示例:

<strong>HUAWEI Mate 80 Pro 16GB+512GB 曜石黑</strong>的价格是 <span style="color:rgb(207, 10, 44);font-size:20">¥6999 </span> <br>

操作系统 <br> HarmonyOS 6.0 <rsup>1</rsup>

屏幕类型 <br> OLED,支持1-120Hz LTPO自适应刷新率,1440Hz高频PWM调光,300Hz触控采样率<rsup>2</rsup> <br> <em>可使用的内存容量小于此值,因为手机软件占用部分空间。</em>

展示效果图: