Markdown 语法介绍

最新推荐文章于 2024-06-09 10:02:18 发布

Jession_Ding

最新推荐文章于 2024-06-09 10:02:18 发布

阅读量1.1k

点赞数

分类专栏：基础设置&&配置文章标签： Markdown 标记语言语法

本文链接：https://blog.csdn.net/Jession_Ding/article/details/54743894

版权

基础设置&&配置专栏收录该内容

7 篇文章 0 订阅

订阅专栏

Markdown 是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，可以使普通文本内容具有一定的格式。用它来编辑文字，可以使文档快速排版，让文字创作者专注于内容，而不必在排版上花费太多的时间。其具有轻量、简单、通用的特点，拥有一种现代的极简美感。

最初的发明者是美国的两位牛人 John Gruber 和 Aaron Swartz，语法解析核心库也是它们完成的。具体相关详细信息，详见 Markdown 百度百科中文和 Markdown 维基百科英文。

接下来，将详细介绍 Markdown 语法的使用与使用效果展示。

Markdown 语法初阶(能够满足日常基本的写作需求)

1. 分级标题

在 Markdown 格式中，标题一共有六级，每级随着#号增加依次递减。语法是#加一个空格，然后书写标题内容。

语法展示：

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

效果展示：

标题11-1

注：等号和减号也可以进行标题的书写，不过等号书写一级标题，减号书写二级标题，并写在文字的下面，等号或等号的数量不影响标题的等级。

语法与效果：

分级标题11-11

2. 引用

语法格式为：>号加一个空格，然后书写引用内容

语法与效果：

引用11-2

3. 斜体与粗体

斜体的使用，是在需要加斜的文字前后各加一个*。而粗体则是，在需要加粗的文字前后各加两个*。粗斜体效果则是在文字前后各加三个*。

语法与效果：

斜粗体11-3

4. 外链接与图片

链接是使用[]()来表示的，中括号中需填写链接的文字描述，而圆括号是需要添加的url链接。图片则是![]()来表示，比链接多了个!号，中括号中需填写图片的文字描述，而圆括号是需要添加的相应图片链接。

语法与效果：

链接与图片11-4

5. 无序列表与有序列表

无序列表使用符号*、+、-加一个空格，然后写列表名。

语法与效果

无序列表11-51

有序列表则是使用数字和点，加一个空格，然后加列表名。

语法与效果

有序列表11-52

如果要控制列表的层级，则需要在符号或者数字前，加空格。(空格的多少视具体的编译器决定)

6. 行内代码块与无高亮效果代码块

在一个行内，若需引用代码的话，用反引号 `` 引起来就好。

语法与效果

行内代码块11-61

无高亮效果代码块，使用Tab(四个缩进空格) 起始，然后中间加内容。在其内的各种包含 Markdown 的语法格式，都不能被解析。

语法与效果

代码块11-61

7. 分割线与删除线

可在一行中，使用三个或及以上的星号*、减号-、底线_来表示一个分割线。

语法与效果

分割线11-71

在需删除的文字前后，使用两个～，则可达到删除效果。

语法与效果

删除线11-72

Markdown 语法高阶(专业性比较强)

1. 内容目录

在段落中填写[TOC]以显示全文内容的目录结构。

语法与效果

内容目录21-1

2. 标签分类

在任意行输入以下代码给文稿加标签：

标签：数学 英语 Markdown
或者
Tags：数学 英语 Markdown

语法与效果

标签分类21-2

3. 注脚

在要使用注脚的字或词后，使用[^关键字]表示注脚。

这是一个注脚1的样例。
这是第二个注脚2的样例。

语法与效果

注脚21-3

4. 表格支持

使用冒号来定义表格的对齐方式。

语法与效果

表格支持21-4

5. 代码块与语法高亮

在需高亮的代码块的前一行和后一行使用三个反引号`，且在第一行的反引号后面写上代码所使用的语言种类。若无需高亮效果，则不需要第一行的反引号后面添加代码所使用的语言种类。

无高亮语法与效果

代码块与语法高亮21-51

高亮语法与效果

代码块与语法高亮21-52

代码块与语法高亮21-53

6. LaTeX 公式

$符号加一些内容可表示行内公式。

语法与效果

LaTeX公式21-61

两个$符号加一些内容可表示块级公式。

语法与效果

LaTeX公式21-62

使用MathJax渲染LaTex数学公式，详见 MathJax 参考更多使用方法。

7. 流程图

示例：

语法与效果

流程图21-7

更多语法详见：流程图语法参考

更加详细的流程图语法，可参见：流程图语法参考1 和流程图语法参考2

8. 序列图

示例一：

Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!

示例二：

Title: Here is a title
A->B: Normal line
B-->C: Dashed line
C->>D: Open arrow
D-->>A: Dashed open arrow

语法与效果

序列图21-81

语法与效果

序列图21-82

更多语法详见：序列图语法参考

9. 甘特图

甘特图内在思想简单。基本是一条线条图，横轴表示时间，纵轴表示活动（项目），线条表示在整个期间上计划和实际的活动完成情况。它直观地表明任务计划在什么时候进行，及实际进展与计划要求的对比。

1.gantt 确认将要绘制的是甘特图
2.dateFormat YYYY-MM-DD 规定时间轴
3.title(标题文本)表示甘特图标题
4.section 划分项目，空一个字符，再输入项目名称的文本(section 之间要空行)
5.每个大项目将拆解为若干个小项目，只需在 section 之后另起一行，直接输入小项目名称即可

示例：

    title 项目开发流程
    section 项目确定
        需求分析       :a1, 2016-06-22, 3d
        可行性报告     :after a1, 5d
        概念验证       : 5d
    section 项目实施
        概要设计      :2016-07-05  , 5d
        详细设计      :2016-07-08, 10d
        编码          :2016-07-15, 10d
        测试          :2016-07-22, 5d
    section 发布验收
        发布: 2d
        验收: 3d

语法与效果

甘特图21-9

更多语法详见：甘特图语法参考1 和甘特图语法参考2

10. Mermaid 流程图

1. 书写 grph XX ，用以确定将要绘制的流程图及其类型(XX表示流程图的类型)
2. 流程图分为：
    1. 竖向
        1.1 自上而下
        1.2 自下而上
    2. 横向
        1.1 从左到右
        1.2 从右到左
3. 其对应语法分别：graph TB/graph BT/graph RL/graph LR
    1. TB=top botton(自上而下)
    2. BT=botton top(自下而上)
    3. LR=left right(从左到右)
    4. RL=right left(从右到左)

示例：

    A[Hard edge] -->|Link text| B(Round edge)
    B --> C{Decision}
    C -->|One| D[Result one]
    C -->|Two| E[Result two]

语法与效果

Mermaid流程图21-10

更多语法详见：Mermaid 流程图语法参考

11. Mermaid 序列图

示例：

    Alice->John: Hello John, how are you?
    loop every minute
        John-->Alice: Great!
    end

语法与效果

Mermaid序列图21-11

更多语法详见：Mermaid 序列图语法参考

12. Html 标签

在 Markdown 语法中嵌套 Html 标签，你可以用 Html 写一个纵跨两行的表格：

<table>
    <tr>
        <th rowspan="2">值班人员</th>
        <th>星期一</th>
        <th>星期二</th>
        <th>星期三</th>
    </tr>
    <tr>
        <td>李强</td>
        <td>张明</td>
        <td>王平</td>
    </tr>
</table>

语法与效果

Html标签21-12

13. 待办事宜 Todo 列表

- [ ]表示未完成，- [x]表示已完成，键入字符与字符之间都要保留一个字符的空格。且支持子列表嵌入和其他 Markdown 语法混用。

示例：

- [x] 已完成项目1
    - [x] 已完成事项1
    - [x] 已完成事项2
- [ ] 待办事项1
- [ ] 待办事项2

语法与效果

Todo列表21-13

这里介绍的某些 Markdown 语法格式，在不同的编译器中可能有些许差别，或者根本就不能解析。读者不必担心，这是因为不同编译器的核心解析库不同，或者是后来被修改了，但大体语法是差不离的。

参考资料：
https://en.wikipedia.org/wiki/Markdown
https://www.zybuluo.com/mdeditor?url=https://www.zybuluo.com/static/editor/md-help.markdown
http://knsv.github.io/mermaid/#flowcharts-basic-syntax
http://knsv.github.io/mermaid/#styling39
http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference
http://adrai.github.io/flowchart.js/
http://bramp.github.io/js-sequence-diagrams/
https://knsv.github.io/mermaid/#gant-diagrams
https://knsv.github.io/mermaid/#flowcharts-basic-syntax
https://knsv.github.io/mermaid/#sequence-diagrams
http://fortawesome.github.io/Font-Awesome/3.2.1/icons/
https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments
http://docs.mathjax.org/en/latest/tex.html#tex-eq-numbers
http://baike.baidu.com/link?url=hBG2ZF1NWMfzs7gn5QGLy2kBmC4PG3iDI75-GReqVZoHOayOLBfDia_aFMfkyipk0efeIPYkcNUhUGvo1QoLstWpW0qcGncJth-SPv9SPL7

这是一个注脚的文本。 ↩
这是另一个注脚的文本。 ↩

Jession_Ding

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Markdown 语法介绍

Markdown 是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，可以使普通文本内容具有一定的格式。用它来编辑文字，可以使文档快速排版，让文字创作者专注于内容，而不必在排版上花费太多的时间。其具有轻量、简单、通用的特点，拥有一种现代的极简美感。最初的发明者是美国的两位牛人 John Gruber 和 Aaron Swartz，语法解析核心库也是它们完成的。具体相关详细信息，详见
复制链接

扫一扫

专栏目录