Markdown 语法
注:本文写于2019年2月20日(now:2020)
Markdown 语法
标题语法
Setext格式:
一级标题:在标题行下端书写一行任意长度的(“=”)等号;
二级标题:在标题行下端书写一行任意长度的(“-”)减号。
(因为会造成标题主次错乱,此处不进行效果展示)
- 一级标题写法:
标题行Setext
============
- 二级标题写法:
标题行Setext
------
Atx格式:
在行首插入1-6个#号,来表示1-6级标题,#号和其后的第一个文字之间应该有一个空格,防止在网页上输出#,例如:
# 第一级标题行Atx
###### 第六级标题行Atx
区块引用
在行首使用‘>’角括号。写法如下:
>这是引用的一行
>
>上面是一个空行
>## (此处要有一个空格)这是引用部分的二级标题
上面的教程效果如下:
这是引用的一行
上面是一个空行
这是引用部分的二级标题
强调
使用型号和底线来标记需要强调的区段。
总的来讲,语法要素为:每一侧使用一个*或者_使其中的文字变得倾斜,每一侧使用两个**或者_使其中的文字变得加粗
例如:
这句话中 *here emphasized* 是强调的部分
这句话中 _here emphasized_ 是强调的部分
这句话中 **strong emphasized** 是加强强调的部分
这句话中 __here emphasized__ 是加强强调的部分
上面的教程效果如下:
这句话中 here emphasized 是强调的部分
这句话中 here emphasized 是强调的部分
这句话中 strong emphasized 是加强强调的部分
这句话中 here emphasized 是加强强调的部分
表格
输出一个表格
对齐格式:
- 居左::----
- 居中::----:或-----
- 居右:----:
写法如下:
|左标题|中标题|右标题|
|:---|:---:|---:|
|左测试文本|中测试文本|右测试文本|
|左测试文本+|中测试文本+|右测试文本+|
|左测试文本++|中测试文本++|右测试文本++|
|左测试文本+++|中测试文本+++|右测试文本+++|
上面的教程效果如下:
左标题 | 中标题 | 右标题 |
---|---|---|
左测试文本 | 中测试文本 | 右测试文本 |
左测试文本+ | 中测试文本+ | 右测试文本+ |
左测试文本++ | 中测试文本++ | 右测试文本++ |
左测试文本+++ | 中测试文本+++ | 右测试文本+++ |
列表
无序列表
以下示例中将 * 换成 + 或 - 效果相同
* Candy
* Gum
* Booze
上面的教程效果如下:
- Candy
- Gum
- Booze
有序列表
使用一般的数字和一个英文句点作为项目标记
1.Red
2.Green
3.Blue
上面的教程效果如下:
- Red
- Green
- Blue
下面这几行没看懂
- A list item.
With multiple paragraphs. - Another item in the list.
如果你在项目之间插入空行,那项目的内容会用 p左右分别加上角括号(不会打)包起来,你也可以在一个项目内放上多个段落,只要在它前面缩排 4 个空白或 1 个 tab 。
链接
用[]中括号括出需要插上链接的文本.
语法如下:
行内式链接: [需要附加链接的文本](链接地址)
[an example link](http://example.com/)
参考式链接: [需要附加链接的文本][链接标记]
[连接标记]: 链接地址 "链接提示文本"(该文本可以省略)
[Google][1]
[1]: http://google.com/ "本行可以在文章的任意地方书写"
链接提示文本(当指向链接时显示的文本):
在链接后面先写空格再写提示文本(英文引号括住)
[example link](http://example.com/ "you can see what i say").
文内链接,即链接到文内某一部分
1. 先定义一个锚(id)
<span id="jump">Hello World</span>
2. 然后使用markdown的语法:
[XXXX](#jump)
示例如下:
第一个例子(行内式链接):圈出的是an example link ;
第二个例子(参考式链接):圈出的是example link,在后面用括号括住链接,括号中元素为: 链接+鼠标指向链接时显示的文字;
第三个例子(链接提示文本):提示文本为"you can see what i say";
+ This is [an example link](http://example.com/).
+ I get 10 times more traffic from [Google][1] than from
[Yahoo][2] or [MSN][3].
+ This is an [example link](http://example.com/ "you can see what i say").
[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://search.msn.com/ "MSN Search"
上面的教程效果如下:
- This is an example link.
- I get 10 times more traffic from Google than from
Yahoo or MSN. - This is an example link.
图片
在md文档中插入图片。
语法如下:
![图片文本(可省略)](图片地址)
示例如下:
![图片文本](https://highestpeak.github.io/upload/image/avatar.png)
上面的教程效果如下:
插入代码
插入的代码分为行内代码和区块代码(代码块)
行内代码
行内代码可以嵌入到文字和段落中
行内代码使用`代码`表示
写法如下:
这是行内代码`System.out.println("Hello world!");`的示例
上面的教程效果如下:
这是行内代码System.out.println("Hello world!");
的示例
区块代码
区块代码可以嵌入一段代码块
写法如下:
代码块使用4个空格或者```标识(注意本块内的英文```改用···代替)
1.下面这种写法没有语法高亮
···
这里书写代码
···
2.下面这种写法有语法高亮
··· 语言名称
//注意语言前面有空格
这里书写代码
···
代码块和语法高亮的示例:
(注意本块内的英文```改用···代替)
··· java
public class JavaText{
public static void main(String[] agrs){
System.out.println("Hello world!");
}
}
···
上面的教程效果如下:
public class JavaText{
public static void main(String[] agrs){
System.out.println("Hello world!");
}
}
HTML的使用
markdown可以方便的书写文本,但是也有一下不足,他不能设置对齐方式文字字体和颜色等等等等,但是可以通过在文本中嵌套HTML来实现这个效果,理论上所有的HTML语法都可应用到markdown中。
字体
示例:
<font face="华文行楷" color="#3d9887" size="3">字体及字体颜色和大小</font>
<font color="#ca246a">字体颜色</font>
上面的教程效果如下:
字体及字体颜色和大小
字体颜色和大小
换行
示例:
使用html的换行符<br>这里换行
使用html的换行符
这里换行
对齐
示例:
<p align="left">居左文本</p>
<p align="center">居中文本</p>
<p align="right">居右文本</p>
上面的教程效果如下:
居左文本
居中文本
居右文本
## 下划线其他符号的输出
上角标
n<sup>2</sup>
效果为: n2
Underlined Text