贡献指南
Markdown 语法指南
相关信息
更多信息请参阅 Markdown 教程
反引号(`)
使用单个反引号(`)来以代码格式显示文本
| 示例 | 效果 |
|---|---|
| 插入`代码`到文本中 | 插入代码到文本中 |
使用两个反引号(``)来转义其他反引号
| 反引号转义 | 反斜线转义 | 效果 |
|---|---|---|
| `` 这是`单个反引号`的作用 `` | 这是\`单个反引号\`的作用 | 这是单个反引号的作用 |
使用三个反引号(```)来形成围栏代码块
示例:
```Python
print("Hello World!")
```效果:
print("Hello World!")将 python 替换成其他语言可以添加对应语言的语法高亮显示,在使用 jsx 语法时,可以使用 Shiki Transformers 来标记新增和删除的行。
具体效果参考风格指南。
表格
添加表格时,请使用三个或更多连字符(---)创建每列的标题,并使用竖线(|)分隔每列。其余文字内容以外的改变不会影响最终结果(例如连字符的数量,竖线前面的空格)。
风格示例:
| Syntax | Description |
| --------- | ----------- |
| Header | Title |
| Paragraph | Text |
| EOL | Line Feed |表格对齐
在连字符的左/右侧添加冒号(:)会将该列的内容向左/右对齐,而在两侧都添加冒号则会居中对齐。
示例:
| 向左对齐 | 居中对齐 | 向右对齐 |
| :----------- | :------: | -----------: |
| 这依旧有文字 | 这是文字 | 这仍然是文字 |
| 那还是有文字 | 那有文字 | 那是更多文字 |效果:
| 向左对齐 | 居中对齐 | 向右对齐 |
|---|---|---|
| 这依旧有文字 | 这是文字 | 这仍然是文字 |
| 那还是有文字 | 那有文字 | 那是更多文字 |