Skip to content
从今夜白

Markdown 示例

Markdown, Example1 min read

本文由 简悦 SimpRead 转码, 原文地址 www.jianshu.com,有部分修改

1. 标题语法:

Markdown 支持两种标题的语法,Setext 形式和 Atx 形式
Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题)

1例如:
2A First Level Header
3====================
4A Second Level Header
5---------------------

A First Level Header

A Second Level Header

Atx 形式在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶。

1例如:
2# 一级标题
3## 二级标题
4### 三级标题
5#### 四级标题
6##### 五级标题
7###### 六级标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

2. 引用

区块引用则使用 email 形式的 '>' 角括号。

1例如:
2> 引用
3>
4> > 引用中的引用
5>
6> ## 引用中的标题

引用

引用中的引用

引用中的标题

3. 修辞和强调

Markdown 使用星号和底线来标记需要强调的区段。单标记表示斜体,双标记表示粗体

1例如:
2使用单星号: *星号斜体*
3使用单下划线: _下划线斜体_
4使用双星号: **星号粗体**
5使用双下划线: __下划线粗体__

使用单星号: 星号斜体
使用单下划线: 下划线斜体

使用双星号: 星号粗体
使用双下划线: 下划线粗体
删除线:使用双波浪包含表示文字被添加删除线

1~~删除线~~

删除线

4. 列表

无序列表:使用星号、加号和减号来做为列表的项目标记

1星号:
2* Candy.
3* Gum.
4* Booze.
  • Candy.
  • Gum.
  • Booze.
1加号:
2+ Candy.
3+ Gum.
4+ Booze.
  • Candy.
  • Gum.
  • Booze.
1减号:
2- Candy.
3- Gum.
4- Booze.
  • Candy.
  • Gum.
  • Booze.

有序列表:使用一般的数字接着一个英文句点作为项目标记,数字不能省略但可无序,点号之后的空格不能少

11. Red
24. Green
33. Blue
  1. Red
  2. Green
  3. Blue

嵌套列表:
-+* 可循环使用,但符号之后的空格不能少,符号之前的空格也不能少

1- 嵌套列表1
2 + 嵌套列表1a
3 + 嵌套列表1b
4 - 嵌套列表1ai
5 * 嵌套列表1aix
6- 嵌套列表2
  • 嵌套列表 1

  • 嵌套列表 1a

  • 嵌套列表 1b

    • 嵌套列表 1ai
      • 嵌套列表 1aix
  • 嵌套列表 2

5. 分割线

三个或更多 -_*,必须单独一行,可含空格(注意如果在文字后使用 ---,则为副标题)

1---
2___
3***

效果:


6. 链接与图片

在 Markdown 中,插入链接不需要其他按钮,你只需要使用[显示文本](链接地址) 这样的语法即可,例如:

1文字超链:
2
3[GitHub](http://www.github.com)
4
5索引超链:
6
7[Google][1]
8[1]:http://www.google.com
9
10自动链接:http://www.google.com
11
12邮箱链接:<[email protected]>

文字超链: GitHub

索引超链: Google

自动链接:http://www.google.com

邮箱链接:[email protected]

图片超链:在 Markdown 中,插入图片不需要其他按钮,你只需要使用 ![image](https://xxx.jpg] 这样的语法即可,例如:

1![congjinyebaiya](https://congjinyebaiya-pics.oss-cn-hangzhou.aliyuncs.com/default.new.png)

注:插入图片的语法和链接的语法很像,只是前面多了一个 !。*

7. 添加代码

Markdown 语法:

1`字符`(简短文字添加代码框)
2`Tab`或四个空格(大段文字添加代码框,每行前添加)

字符
Tab或四个空格

大段代码框:在你的代码块的前面和后面都加上三个反引号 ` 即可,在第一行后指定编程语言,也可以不指定

1@requires_authorization
2def somefunc(param1='', param2=0):
3 '''A docstring'''
4 if param1 > param2: # interesting
5 print 'Greater'
6 return (param2 - param1 + 1) or None
7class SomeClass:
8 pass
9>>> message = '''interpreter
10... prompt'''

8. 转义字符

特殊符号前可以加反斜线表示转义

1\\ 反斜杠
2
3\` 反引号
4
5\* 星号
6
7\_ 下划线
8
9\{\} 大括号
10
11\[\] 中括号
12
13\(\) 小括号
14
15\+ 加号
16
17\- 减号
18
19\. 英文句号
20
21\! 感叹号

\ 反斜杠
` 反引号

  • 星号
    _ 下划线
    {} 大括号
    [] 中括号
    () 小括号
  • 加号
  • 减号
    . 英文句号
    ! 感叹号

9. 表格

  • 使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行:
1name | age 区分单元格
2---- | --- 分隔表头和其他行
3LearnShare | 12
4Mike | 32
nameage
LearnShare12
Mike32
  • 为了美观,可以使用空格对齐不同行的单元格,并在左右两侧都使用来标记单元格边界:
1| name | age |
2| ---------- | --- |
3| LearnShare | 12 |
4| Mike | 32 |
nameage
LearnShare12
Mike32
  • 在表头下方的分隔线标记中加入 :,即可标记下方单元格内容的对齐方式:
1| left | center | right |
2| :--- | :----: | ----: |
3| aaaa | bbbbbb | ccccc |
4| a | b | c |
leftcenterright
aaaabbbbbbccccc
abc

10. 其他

  • 段落缩进
1半方大的空白 或 看,飞碟
2全方大的空白 或 看,飞碟
3不断行的空白格 或 看,飞碟
4  段落从此开始。