Markdown语言常用语法

本文主要记录Markdown语言的常用语法,做为备忘,本文内容主要参考:
https://segmentfault.com/markdown

一、代码

1. 行内代码

用法

把代码用反引号 ` (键盘上Esc键下面的键)包起,如:

`toString()`方法

效果

toString()方法

2. 代码块

用法1

用 3个`(Esc下面的键)包裹一段代码,并指定一种语言,如:

1
2
3
4
5
```java  
public class BookViewHolder extends RecyclerView.ViewHolder {
public TextView tvBook;
}
```

用法2

也可以在代码块的每一行使用 4 空格缩进,实现相同的的效果,此处不再举例,可自己尝试。

效果

1
2
3
public class BookViewHolder extends RecyclerView.ViewHolder {
public TextView tvBook;
}

支持的语言:actionscript, apache, bash, clojure, cmake, coffeescript, cpp, cs, css, d, delphi, django, erlang, go, haskell, html, http, ini, java, javascript, json, lisp, lua, markdown, matlab, nginx, objectivec, perl, php, python, r, ruby, scala, smalltalk, sql, tex, vbscript, xml

二、标题

用法

使用1-6个#号连接内容,如:

# 一级标题
## 二级标题
### 三级标题

效果

一级标题

二级标题

三级标题

三、粗体、斜体、删除线

用法

正常字前后不加*号,1个*为斜体,2个*为粗体,3个*为粗斜体,如:

这是正常的字
*这是斜体的字*
**这是加粗的字**
***这是粗斜体的字***
~~这是删除线~~

效果

这是正常的字
这是斜体的字
这是加粗的字
这是粗斜体的字
这是删除线

四、链接

1. 常用链接方法

用法

文字链接: [百度](http://www.baidu.com)  
网址链接: <http://www.baidu.com>

效果

文字链接: 百度
网址链接: http://www.baidu.com

2. 高级链接技巧

用法

这个链接用 1 作为网址变量 [Google][1].
这个链接用 yahoo 作为网址变量 [Yahoo!][yahoo].

然后在文档的结尾为变量赋值(网址):
  [1]: http://www.google.com/
  [yahoo]: http://www.yahoo.com/

效果

这个链接用 1 作为网址变量 Google.
这个链接用 yahoo 作为网址变量 Yahoo!.

五、图片

1. 用法1

跟链接的方法区别在于前面加了个感叹号!,这样是不是觉得好记多了呢?

用法

![图片名称](http://图片网址),如:
![奇犽](http://7xlpfl.com1.z0.glb.clouddn.com/16-10-1/61240869.jpg)

效果

奇犽

2. 用法2

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

这个链接用 1 作为网址变量 [Google][1].  
然后在文档的结尾位变量赋值(网址)

 [1]: http://www.google.com/logo.png

3. 用法3

也可以使用 HTML 的图片语法来自定义图片的宽高大小:

<img src="htt://example.com/sample.png" width="250" height="250" alt="奇犽">

4. 用法4

如果使用七牛进行存储的图片,还可以在URL后面添加参数,控制加载的图片大小:

?imageView2/2/w/100/ ?imageView2/2/w/150/ ?imageView2/2/w/200/
奇犽 奇犽 奇犽

具体参数可参考七牛图片处理接口文档

六、列表

1. 普通无序列表

用法

- 列表文本前使用 [减号+空格]
+ 列表文本前使用 [加号+空格]
* 列表文本前使用 [星号+空格]

效果

  • 列表文本前使用 [减号+空格]
  • 列表文本前使用 [加号+空格]
  • 列表文本前使用 [星号+空格]

2. 普通有序列表

用法

1. 列表前使用 [数字+空格]
2. 我们会自动帮你添加数字
7. 不用担心数字不对,显示的时候我们会自动把这行的 7 纠正为 3

效果

  1. 列表前使用 [数字+空格]
  2. 我们会自动帮你添加数字
  3. 不用担心数字不对,显示的时候我们会自动把这行的 7 纠正为 3

3. 列表嵌套

用法

1. 列出所有元素:
    - 无序列表元素 A
        1. 元素 A 的有序子列表
    - 前面加四个空格
2. 列表里的多段换行:
    前面必须加四个空格,
    这样换行,整体的格式不会乱
3. 列表里引用:

    > 前面空一行
    > 仍然需要在 >  前面加四个空格

4. 列表里代码段:

效果

  1. 列出所有元素:
    • 无序列表元素 A
      1. 元素 A 的有序子列表
    • 前面加四个空格
  2. 列表里的多段换行:
    前面必须加四个空格,
    这样换行,整体的格式不会乱
  3. 列表里引用:

    前面空一行
    仍然需要在 > 前面加四个空格

  4. 列表里代码段:
    待补充。

七、引用

1. 普通引用

用法

> 引用文本前使用 [大于号+空格]  
> 折行可以不加,新起一行都要加上哦

效果

引用文本前使用 [大于号+空格]
折行可以不加,新起一行都要加上哦

2. 引用里嵌套引用

用法

> 最外层引用
> > 多一个 > 嵌套一层引用
> > > 可以嵌套很多层

效果

最外层引用

多一个 > 嵌套一层引用

可以嵌套很多层

3. 引用里嵌套列表

用法

> - 这是引用里嵌套的一个列表
> - 还可以有子列表
>     * 子列表需要从 - 之后延后四个空格开始

效果

  • 这是引用里嵌套的一个列表
  • 还可以有子列表
    • 子列表需要从 - 之后延后四个空格开始

4. 引用里嵌套代码块

用法

>     同样的,在前面加四个空格形成代码块

效果

同样的,在前面加四个空格形成代码块

八、换行

如果另起一行,只需在当前行结尾加 2 个空格

在当前行的结尾加 2 个空格  
这行就会新起一行

如果是要起一个新段落,只需要空出一行即可。

九、分隔符

如果你有写分割线的习惯,可以新起一行输入三个减号-。当前后都有段落时,请空出一行:

前面的段落
---
后面的段落

十、符号转义

如果你的描述中需要用到 markdown 的符号,比如 _ # * 等,但又不想它被转义,这时候可以在这些符号前加反斜杠\进行避免。

用法

\_不想这里的文本变斜体\_
\*\*不想这里的文本被加粗\*\*

效果

_不想这里的文本变斜体_
**不想这里的文本被加粗**

十一、表格

用法

abc | def | kdka
--- | --- | ---
ld  | dk  | dk
ld  | dk  | dk

效果

abc def kdka
ld dk dk
ld dk dk

十二、复杂表格

1. 在Excel中填写表格

在 Excel 中正常填写你的表格内容,之后在标题行下插入一行,要居中的填入:-:,要右对齐的填-:其它全部填上-

2. 生成表格

复制、粘贴表格:

选中表格,复制,然后粘贴到 Markdown 编辑器中。

用|替换tab:

复制出来的 Excel 默认以tab作为单元格分隔符,而 Markdown 则以|为分隔符。顺理成章,当我们使用 | 对原tab分隔符进行替换后,即可生成 Markdown 化的表格:

-|左对齐|居中对齐|右对齐
:-:|-|:-:|-:
1|Left|Center|Right
2|Left|Center|Right
3|Left|Center|Right

效果

- 左对齐 居中对齐 右对齐
1 Left Center Right
2 Left Center Right
3 Left Center Right

3. 在线生成Markdown表格

http://www.tablesgenerator.com/markdown_tables

4. 复杂表格生成办法

我们仍然建议使用其他的方式替代复杂的表格,甚至尽量少用表格。

在你本地或者远程的HTML编辑器上生成复杂表格,然后粘贴表格的HTML代码到编辑区即可。

感谢你的支持,让我继续努力分享有用的技术和知识点!