markdown语法指南

markdown语法指南

1. markdown简介

Markdown 是一种轻量级标记语言，创始人为约翰·格鲁伯（John Gruber）。 它允许人们使用易读易写的纯文本格式编写文档，然后转换成有效的 XHTML（或者HTML）文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。
由于 Markdown 的轻量化、易读易写特性，并且对于图片，图表、数学式都有支持，许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。 如 GitHub、Reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge、简书等，甚至还能被使用来撰写电子书。

2. 标题

一级标题 (# 一级标题)

二级标题 (## 二级标题)

三级标题 (### 三级标题)

四级标题 (#### 四级标题)

五级标题 (##### 五级标题)
六级标题 (###### 六级标题)

注意：有的编辑器需要加空格，这里加不加都行，建议习惯加上空格。

3. 粗体

粗体 (**粗体**)
粗体 (__粗体__)
粗体 (<B>粗体</B>)

4. 斜体

斜体 (*斜体*)
斜体 (_斜体_)

5. 下划线

下划线（<u>下划线</u>）

注意：不建议使用，因为有时候容易与链接混淆

6. 删除线

删除线 (~~删除线~~)
删除线 (<s>删除线</s>)

7. 无序列表

  • 列表内容
  • 列表内容
  • 列表内容
    • 嵌套列表内容
    • 嵌套列表内容
    • 嵌套列表内容
* 列表内容
+ 列表内容
- 列表内容
    * 嵌套列表内容
    - 嵌套列表内容
    + 嵌套列表内容

注意：使用-+都可以，但是-+跟列表内容之间都要有空格，如果需要列表嵌套，只需多加三个空格或一个tab制表符即可，有的编辑器只能tab，这里三个空格和一个tab都行，建议习惯使用tab。

8. 有序列表

  1. 列表内容
  2. 列表内容
  3. 列表内容
    1. 嵌套列表内容
    2. 嵌套列表内容
    3. 嵌套列表内容
1. 列表内容
2. 列表内容
3. 列表内容
    1. 嵌套列表内容
    2. 嵌套列表内容
    3. 嵌套列表内容

注意：序号跟内容之间要有英文句号和空格，如果需要列表嵌套，只需多加三个空格或一个tab制表符即可，有的编辑器只能tab，这里三个空格和一个tab都行，建议习惯使用tab。

  • 内联方式

    • 示例

      • 不显示文本(只显示链接)

        https://www.baidu.com (<https://www.baidu.com>)

      • 显示文本(不显示链接)

        百度首页 ([百度首页](https://www.baidu.com "百度一下"))

        This is an example link (This is an [example link](http://example.com/))

    • 格式说明

      [超链接名](超链接地址 "超链接title")

超链接title：超链接的标题，当鼠标移到超链接上时显示的内容，可加可不加，建议加上title。

  • 引用方式

    • 示例效果

      I get 10 times more traffic from Google than from Yahoo or MSN.

    • 示例语法

      I get 10 times more traffic from [Google][1] than from [Yahoo][2] or [MSN][3].

[1]: http://google.com/ "Google" 
[2]: http://search.yahoo.com/ "Yahoo Search" 
[3]: http://search.msn.com/ "MSN Search"
注意：第一行与下面的标号之间，必须空一行

    • 格式说明

      [超链接名][id] 

[id]: 超链接地址 "超链接title"
id：可以是数字、英文字符，也可以是中文，建议直接使用数字即可，简单明了。
超链接title：超链接的标题，当鼠标移到超链接上时显示的内容，可加可不加，建议加上title。

10. 图片 (Images)

  • 内联方式

    • 示例效果

      百度首页图片

    • 示例语法

      ![百度首页图片](https://www.baidu.com/img/flexible/logo/pc/result.png "百度一下")

    • 格式说明

      ![alt text](图片地址 "图片title")
alt text：图片的替代文字，也就是当图片还未加载成功时显示的替换文本
图片title：图片的标题，当鼠标移到图片上时显示的内容，可加可不加，建议加上title。

  • 引用方式

    • 示例效果

      百度首页图片

    • 示例语法

      ![百度首页图片][100] 

[100]: https://www.baidu.com/img/flexible/logo/pc/result.png "百度一下"

    • 格式说明

      ![alt text][id] 

[id]: 图片地址 "图片title"
alt text：图片的替代文字，也就是当图片还未加载成功时显示的替换文本，建议加上，用图片名表示。
id：可以是数字、英文字符，也可以是中文，建议直接使用数字即可，简单明了。
图片title：图片的标题，当鼠标移到图片上时显示的内容，可加可不加，建议加上title。

11. 引用 (块注释：blockquote)

通过在文字开头添加>或>加空格表示块注释，空格加不加都可以，建议习惯加上。
（当>和文字之间添加一个空格和一个tab时，展示为> 和tab的叠加效果）

  • 示例效果

    这是一段引用内容

    这是一段引用内容

    这是一段引用内容

    这是一段引用内容

  • 示例语法

    > 这是一段引用内容
>> 这是一段引用内容
>>> 这是一段引用内容

>     这是一段引用内容

12. 代码

  • 示例效果

    def add_two_number(a, b):
    return a + b

n = add_two_number(2,5)
print(n)

  • 示例语法

    ```python
def add_two_number(a, b):
    return a + b

n = add_two_number(2,5)
print(n)
```

  • 格式说明

    ```编程语言
代码片段
```

13. 表格

  • 基础示例

    • 示例效果

      项目 价格
      iPhone $560
      iPad $780
      iMac $1000

    • 示例语法

      |项目|价格|
|-|-|
|iPhone|$560|
|iPad|$780|
|iMac|$1000|

  • 进阶示例
    可以使用冒号来定义对齐方式

    • 示例效果

      项目 价格 数量
      iPhone 6000元 5
      iPad 3800元 12
      iMac 10000元 234

    • 示例语法

      |项目|价格|数量|
|-|:-:|-:|
|iPhone|6000元|5|
|iPad|3800元|12|
|iMac|10000元|234|

    • 格式说明

      每行都用|分隔，(行首行位尾可不加|)；
第二行用一个或多个-填充，以区分表头；此外可以用:-、:-:、-:表示左中右三种对齐方式，默认是左对齐。

14. 流程图 (博客园和简书不支持)

15. 以代码框形式显示文本内容 (类似代码块)

  • 用两个`包起来的只显示成单行代码块

    • 示例效果

      123 123 123

    • 示例语法

      `
123
123
123
`

  • 用两个```包起来的可以显示为多行代码块

    • 示例效果

      123
123
123

    • 示例语法

      ```
123
123
123
```

  • 在行首添加tab，也可以实现多行代码块

    • 示例效果

      123
123
123

    • 示例语法

        123
  123
  123

16. 分割线

  • 示例效果

  • 示例语法

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

  • 格式说明

    用不少于三个的-或者*表示，前面必须空一行

17. 特殊符号的转义

  • 示例效果

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

  • 示例语法

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

  • 格式说明

    在用markdown输入特殊符号（反斜线、反引号、星号、底线、花括号、方括号、括弧、井字号、加号、减号、英文句点、惊叹号等）的时候一定要注意转义，否则将导致内容显示不全，甚至排版混乱。切记切记！！

18. 脚注（footnote）

  • 示例效果

    hello[1]
    forever[2]

  • 示例语法

    hello[^hello]
forever[^forever]

[^hello]: hi
[^forever]: love

  1. hi ↩︎

  2. love ↩︎

posted @ 2019-05-06 15:30  刘清钧  阅读(472)  评论(0)    收藏  举报