Markdown简明语法

Markdown简明语法

Symon 631 2020-10-08

Markdown 简介

  • Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。
  • Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建。
  • Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
  • Markdown 编写的文档后缀为 .md, .markdown。

Markdown 应用

Markdown 能被使用来撰写电子书,如:Gitbook。
当前许多网站都广泛使用 Markdown来撰写帮助文档或是用于论坛上发表消息。

例如:GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。

Markdown 标题

Markdown 标题有两种格式。
1、使=-标记一级和二级标题
=-标记语法格式如下:

我展示的是一级标题
===
我展示的是二级标题
---

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

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

Markdown 段落

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车。当然也可以在段落后面使用一个空行来表示重新开始一个段落。

Markdown 字体

Markdown 可以使用以下几种字体:

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

Markdown 分隔线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

***
* * *
*****
- - -
----------

Markdown 删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线~~即可,实例如下:

~~删除线~~

Markdown 下划线

下划线可以通过 HTML 的<u> 标签来实现:

<u>带下划线文本</u>

Markdown 脚注

脚注是对文本的补充说明。
Markdown 脚注的格式如下:

[^要注明的文本]

以下实例演示了脚注的用法:

创建脚注格式类似这样 [^JAVA]。
[^JAVA]: JAVA是世界上最好的语言!!!

Markdown 列表

Markdown 支持有序列表和无序列表。
无序列表使用星号*、加号+或是减号-作为列表标记:

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项

- 第一项
- 第二项
- 第三项

有序列表使用数字并加上.号来表示,如:

1. 第一项
2. 第二项
3. 第三项

列表嵌套
列表嵌套只需在子列表中的选项添加四个空格即可:

1. 第一项:
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项:
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

Markdown 区块

Markdown 区块引用是在段落开头使用>符号 ,然后后面紧跟一个空格符号:

> 区块引用  
> java开发  

另外区块是可以嵌套的,一个>符号是最外层,两个>符号是第一层嵌套,以此类推:

> 最外层
> > 第一层嵌套
> > > 第二层嵌套

区块中使用列表
区块中使用列表实例如下:

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

列表中使用区块
如果要在列表项目内放进区块,那么就需要在>前添加四个空格的缩进。
区块中使用列表实例如下:

* 第一项
    > java  
    > 最好的语言
* 第二项

GFM task list

- [x] GFM task list 1
- [x] GFM task list 2
- [ ] GFM task list 3
    - [ ] GFM task list 3-1
    - [ ] GFM task list 3-2
    - [ ] GFM task list 3-3
- [ ] GFM task list 4
    - [ ] GFM task list 4-1
    - [ ] GFM task list 4-2

Markdown 代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:

`println()` 函数

代码区块
代码区块使用 4 个空格或者一个制表符(Tab键)。

你也可以用 ``` 包裹一段代码,并指定一种语言(也可以不指定):

@Test
void contextLoads() {
    System.out.println("test");
}

Markdown 链接

链接使用方法如下:

[链接名称](链接地址)  
或者  
<链接地址>

例如:

[百度](https://www.baidu.com)

高级链接
我们可以通过变量来设置一个链接,变量赋值在文档末尾进行:

This is [example] [id] reference-style link.

[id]: http://example.com/  "Optional Title Here"

Markdown 图片

Markdown 图片语法格式如下:

![alt 属性文本](图片地址)
![alt 属性文本](图片地址 "可选标题")
  • 开头一个感叹号!
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址
  • 最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字

使用实例:

![百度 图片](http://a.hiphotos.baidu.com/zhidao/pic/item/32fa828ba61ea8d325659842960a304e251f5835.jpg)
![百度 图片](http://a.hiphotos.baidu.com/zhidao/pic/item/32fa828ba61ea8d325659842960a304e251f5835.jpg "图片")

当然,你也可以像网址那样对图片网址使用变量:

这个链接用url作为网址变量 ![百度图片][url].  
然后在文档的结尾为变量赋值(网址)  

[url]: http://a.hiphotos.baidu.com/zhidao/pic/item/32fa828ba61ea8d325659842960a304e251f5835.jpg

Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的<img>标签。

<img src="http://a.hiphotos.baidu.com/zhidao/pic/item/32fa828ba61ea8d325659842960a304e251f5835.jpg" width="50%">

Markdown 表格

Markdown 制作表格使用|来分隔不同的单元格,使用-来分隔表头和其他行。
语法格式如下:

|  表头   |  表头  |
|  -----  | -----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

对齐方式
我们可以设置表格的对齐方式:
-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。
实例如下:

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格单元格 | 单元格单元格 | 单元格单元格 |

Markdown 高级技巧

支持的 HTML 元素
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。
要制约的只有一些 HTML 区块元素――比如 <div> <table> <pre> <p> 等标签,
必须在前后加上空行与其它内容区隔开,还要求它们的开始标签与结尾标签不能用制表符或空格来缩进。Markdown 的生成器有足够智能,不会在 HTML 区块标签外加上不必要的<p>标签。
如:


<table>
    <tr>
        <td>Foo</td>
    </tr>
</table>

HTML 的区段(行内)标签如 <span> <cite> <del> 可以在 Markdown 的段落、列表或是标题里随意使用。
如:

使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

转义

Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:

**文本加粗** 
\*\* 正常显示星号 \*\*

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

特殊符号

&copy; &  &uml; &trade; &iexcl; &pound;

&amp; &lt; &gt; &yen; &euro; &reg; &plusmn; &para; &sect; &brvbar; &macr; &laquo; &middot;

X&sup2; Y&sup3; &frac34; &frac14;  &times;  &divide;   &raquo;

18&ordm;C  &quot;  &apos;

© & ¨ ™ ¡ £

& < > ¥ € ® ± ¶ § ¦ ¯ « ·

X² Y³ ¾ ¼ × ÷ »

18ºC " '


关注微信公众号