1.1、段落标题
根据原文中的文档标题可以对应设置标题。
# 一级标题
## 二级标题
### 三级标题
效果 =>
一级标题
二级标题
三级标题
1.2、斜体、加粗
*单星号* => 单星号
_单下划线_ => 单下划线
**双星号** => 双星号
__双下划线__ => 双下划线
1.3、列表
1.3.1 无序列表示例:
* item1
* item2
* item3
效果 =>
- item1
- item2
- item3
1.3.2 有序列表示例:
1. item1
1. item2
1. item3
效果 =>
- item1
- item2
- item3
注意:列表要与上面的内容有换行。
1.3.3 多级列表示例
注意:第二行+前应该有空格。
* item1
+ item1.1
* item2
+ item2.1
效果 =>
- item1
- item1.1
- item1.2
- item2
- item2.1
- item2.2
注意:多级列表只支持2层。
1.4、链接、图片
注意:链接中如果带有特殊符号,比如 & 需要用转义字符进行标示 \&
。
1.4.1 链接
与markdown标准语法兼容。示例:
This is [an example](http://example.com/ “Title”) inline link.
[This link](http://example.net/) has no title attribute.
效果 =>
This is an example inline link.
This link has no title attribute.
1.4.2 图片
图片示例:
![Importnew](http://www.importnew.com/wp-content/uploads/2012/11/importNew-233×50.jpg)
效果 =>
建议:翻译时,可以直接引用原文链接。在提交到Importnew时,可以通过 上传或插入 功能将图片上传并插入到文章。
1.5 代码
1.5.1 说明
使用“表示行内代码。
1.5.2 示例
这是`javascript`代码
1.5.3 块状
空4格 或 Tab键
1.6 Markdown 插入表格语法
1 |
|
一个普通标题 | 一个普通标题 | 一个普通标题 |
---|---|---|
短文本 | 中等文本 | 稍微长一点的文本 |
稍微长一点的文本 | 短文本 | 中等文本 |
1 |
|
左对齐标题 | 右对齐标题 | 居中对齐标题 |
---|---|---|
短文本 | 中等文本 | 稍微长一点的文本 |
稍微长一点的文本 | 短文本 | 中等文本 |
语法说明:
|
、-
、:
之间的多余空格会被忽略,不影响布局。- 默认标题栏居中对齐,内容居左对齐。
-:
表示内容和标题栏居右对齐,:-
表示内容和标题栏居左对齐,:-:
表示内容和标题栏居中对齐。- 内容和
|
之间的多余空格会被忽略,每行第一个|
和最后一个|
可以省略,-
的数量至少有一个。
1.7 SHA 引用(特殊)
每一次 commit 都会产生一个 id,用 @id 的方式可以链接到某个项目的特定的 commit。比如用 jquery/jquery@1b9575b9d14399e9426b9eacdd92b3717846c3f2 就能链接到 jquery 的一次 commit 记录上。
1.8 issue 引用(特殊)
用 #1 来引用当前 repo 的第一个 issue,也可以用 jquery/jquery#1 引用 jquery 的第一次 issue。
1.9 删除符号(通用)
用连续两个 ~ 包围的词会被加上删除符。比如~~This is removed~~