Markdown语法笔记

173 阅读5分钟

标题

使用 # 表示标题:

# + 空格 + 标题内容(一级标题)
## + 空格 + 标题内容(二级标题)
以此类推


段落

段落内换行有两种方式:

  • 2个以上空格 + 回车
  • 空行

字体

Markdown 可以使用支持几种字体:

* + 斜体文本 + * = 斜体文本

_ + 斜体文本 + _ =_ 斜体文本_

** + 粗体文本 + ** = 粗体文本

__ + 粗体文本 + __ = 粗体文本

*** + 粗斜体文本 + *** = 粗斜体文本

___ + 粗斜体文本 + ___ = 粗斜体文本


线

分割线

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

***

* * *

---

_ _ _

删除线

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

~~ + 删除线 + ~~ = 删除线


列表

Markdown 支持有序列表和无序列表。

无序列表

无序列表使用星号 * 、加号+ 或是减号 - 作为列表标记,这些标记后面要添加一个空格,然后再填写内容:

  • 第一项 = * + 第一项
  • 第二项 = * + 第二项
  • 第三项 = * + 第三项

有序列表

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

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

列表嵌套

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

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

显示结果如下:

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

区块

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

> + 空格 + 区块内容1
> + 空格 + 区块内容2
> + 空格 + 区块内容3

显示结果如下:

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

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

显示结果如下:

最外层

第一层嵌套

第二层嵌套

列表中使用区块

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

* 第一项
    > 区块内容1
    > 区块内容2
* 第二项

显示结果如下:

  • 第一项

    区块内容1 区块内容2

  • 第二项

区块中使用列表

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

显示结果如下:

区块中使用列表

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

代码

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

`sin` 函数
`cos` 函数
`tan` 函数

显示结果如下:
sin 函数
cos 函数
tan 函数

代码区块

  1. 使用 4 个空格或者一个制表符(Tab 键)
  2. 用 ** 包裹一段代码,并指定一种语言(也可以不指定) 以 ** 为例:
```java
    public class HelloWorld {
        public static void main(String args[]) {
            System.out.println("Hello World!");
        }
    }
```

显示结果如下:

    public class HelloWorld {
        public static void main(String args[]) {
            System.out.println("Hello World!");
        }
    }

链接

链接使用(以参考文链接为例):

  1. [ + 链接名称 + ] + (链接地址)
  2. < + 链接地址 + >
[MarkDown](http://www.markdown.cn/)
<http://www.markdown.cn/>

显示结果如下:
MarkDown
www.markdown.cn/

3. 通过变量来设置一个链接,变量赋值在文档末尾进行

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

  [1]: http://www.markdown.cn/
  [baidu]: http://www.baidu.com/

显示结果如下:
这个链接用 1 作为网址变量 MarkDown
这个链接用 baidu 作为网址变量 Baidu
然后在文档的结尾为变量赋值(网址)


图片

开头一个感叹号 !
接着一个方括号,里面放上图片的替代文字
接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 'title' 属性的文字。
行内式语法样式如下:

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")

参考式语法样式如下:

![Alt text][id]
[id]:url/to/image  "Optional title attribute"

表格

制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行:

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

显示结果如下:

表头表头
单元格单元格
单元格单元格

对齐方式

我们可以设置表格的对齐方式:

  • -: 设置内容和标题栏居右对齐
  • :- 设置内容和标题栏居左对齐
  • :-: 设置内容和标题栏居中对齐
| 左对齐 | 居中对齐 | 右对齐 |
| :-----| :----: | -----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

显示结果如下:

左对齐居中对齐右对齐
单元格单元格单元格
单元格单元格单元格

技巧

  • 不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写
  • Markdown 使用了很多特殊符号来表示特定的意义需要显示特定的符号则需要使用转义字符,使用反斜杠转义特殊字符
  • 需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeXLaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染