Markdown扩展语法
John Gruber的原始设计文档中概述的基本语法主要是为了应付大多数情况下的日常所需元素,但对于某些人来说还不够,这就是扩展语法的用武之地。
一些个人和组织开始通过添加其他元素(例如表,代码块,语法突出显示,URL自动链接和脚注)来扩展基本语法。可以通过使用基于基本Markdown语法的轻量级标记语言,或通过向兼容的Markdown处理器添加扩展来启用这些元素。
并非所有Markdown应用程序都支持扩展语法元素。您需要检查您的应用程序所使用的轻量级标记语言是否支持您要使用的扩展语法元素。如果没有,那么仍然有可能在Markdown处理器中启用扩展。
Markdown 表格
-
创建表格
-
要添加表,使用三个或多个连字符(—)创建每列的标题,并使用管道(|)分隔每列。您可以选择在表的任一端添加管道。
- 格式:
- | 表头1|表头2|
|--------|-------|
|内容1|内容2|
|内容3|内容4|
显示如下:
- | 表头1|表头2|
- 格式:
表头1 | 表头2 |
---|---|
内容1 | 内容2 |
内容3 | 内容4 |
-
表格内容对齐
- 可以通过在标题行中的连字符的左侧,右侧或两侧添加冒号(:),将列中的文本对齐到左侧,右侧或中心。
- 格式:
- |表头1|表头2|表头3|
- |:-------|:-----: |-------: |
- |内容1|内容2|内容3|
- |内容4|内容5|内容6|
- 显示如下: 第一列左对齐|:-----|,第二列居中|:-----: |,第三列右对齐|------: |
- 格式:
表头1 | 表头2 | 表头3 |
---|---|---|
内容1 | 内容2 | 内容3 |
内容4 | 内容5 | 内容6 |
Markdown 围栏代码块
-
代码块
- Markdown基本语法允许您通过将行缩进四个空格或一个制表符来创建代码块。如果发现不方便,请尝试使用受保护的代码块。根据Markdown处理器或编辑器的不同,您将在代码块之前和之后的行上使用三个反引号(```)或三个波浪号(~~~)。
- 例如:
```
public static void main(String[] args) {
String specifiedCardList = “1111|2222|3333”;
if(specifiedCardList.indexOf(“1111”) == 0) {
System.out.println(“bnkShortName:1111”);
}else {
System.out.print(“空”);
}
}
```
显示如下:
public static void main(String[] args) {
String specifiedCardList = "1111|2222|3333";
if(specifiedCardList.indexOf("1111") == 0) {
System.out.println("bnkShortName:1111");
}else {
System.out.print("空");
}
}
-
代码语法高亮
- 许多Markdown处理器都支持受围栏代码块的语法突出显示。使用此功能,您可以为编写代码的任何语言添加颜色突出显示。要添加语法突出显示,请在受防护的代码块之前的反引号旁边指定一种语言。
- 例如:
```java
public static void main(String[] args) {
String specifiedCardList = “1111|2222|3333”;
if(specifiedCardList.indexOf(“1111”) == 0) {
System.out.println(“bnkShortName:1111”);
}else {
System.out.print(“空”);
}
}
```
显示如下:
public static void main(String[] args) {
String specifiedCardList = "1111|2222|3333";
if(specifiedCardList.indexOf("1111") == 0) {
System.out.println("bnkShortName:1111");
}else {
System.out.print("空");
}
}
Markdown 脚注
-
脚注
- 脚注使您可以添加注释和参考,而不会使文档正文混乱。当您创建脚注时,带有脚注的上标数字会出现在您添加脚注参考的位置。读者可以单击链接以跳至页面底部的脚注内容。
要创建脚注参考,请在方括号([^1])内添加插入符号和标识符。标识符可以是数字或单词,但不能包含空格或制表符。标识符仅将脚注参考与脚注本身相关联-在输出中,脚注按顺序编号。
在括号内使用另一个插入符号和数字添加脚注,并用冒号和文本([^1]: My footnote.)。您不必在文档末尾添加脚注。您可以将它们放在除列表,块引号和表之类的其他元素之外的任何位置。
*格式:脚注测试案例[^1],说明[^2].
[^1]:脚注1示例演示
[^2]:脚注2 示例演示 - 例如:
脚注测试案例1,说明2.
Markdown 定义列表
- 一些Markdown处理器允许您创建术语及其对应定义的定义列表。要创建定义列表,请在第一行上键入术语。在下一行,键入一个冒号,后跟一个空格和定义。
- 格式:
- 第一行
: 演示示例1
第二行
: 演示示例1
: 演示示例1
显示为如下:
-
第一行
- 演示示例1 第二行
- 演示示例1
- 演示示例1
markdown 删除线
- 您可以通过在单词中心放置一条水平线来删除单词。结果看起来像这样。此功能使您可以指示某些单词是一个错误,要从文档中删除。若要删除单词,请在单词前后使用两个波浪号~~。
- 格式: ~~删除线内容~~演示删除线
- 例如:~~删除线内容~~演示删除 显示如下:
删除线内容演示删除
Markdown 任务列表语法
- 任务列表使您可以创建带有复选框的项目列表。在支持任务列表的Markdown应用程序中,复选框将显示在内容旁边。要创建任务列表,请在任务列表项之前添加破折号-和方括号[ ],并在[ ]前面加上空格。要选择一个复选框,请在方括号[x]之间添加 x 。
- 格式:
- [x] 学习
- [ ] 健身
- [ ] 玩游戏
显示如下:
- 学习
- 健身
- 玩游戏