Markdown参考手册


Markdown是一种轻量级标记语言,创始人为John Gruber. 它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页面。

1. 基本语法

1.1 格式

使用星号*或者下划线_表示斜体或加粗。

一对符号是斜体
两对符号是粗体
二者可以叠加,即三对符号为**斜体加粗**

示例:

效果:

使用两对波浪线~添加删除线。

示例:

效果:

若想添加下划线,则只能使用html的<u>标签。

示例:

效果:

1.2 段落

段落是连续的几行文本,段落之间有一行或多行空白行。

示例:

若要添加换行符,请在行尾添加一个反斜杠\或两个空格

示例:

效果:

1.3 标题

在一行文字的前面加井号#表示这行是一个标题,标题文字与最后一个井号#中间需要用一个空格 分隔开。

一个井号#是一级标题,两个井号##是二级标题,以此类推,最多支持六级标题。

示例:

效果:

标题里也可以包含斜体粗体那样的格式。

示例:

效果:

1.4 引用

在一行的开头使用大于号>来创建一个引用块,大于号>后面可以加一个空格 ,也可以不加。

示例:

效果:

若要保持引用块连续,在引用块内的空行必须以大于号>开头。

示例:

效果:

引用块可以嵌套。

示例;

引用块内也可以使用其他Markdown语法。

1.5 列表

无序列表可以使用星号*、加号+或连字符-作为列表标记,标记符后面要跟一个空格

示例:

效果:

有序列表使用数字后跟点.或右括号)

示例:

效果:

有序列表前面的数字可以没有顺序,Markdown会自动从第一个数字开始按顺序显示。

示例:

效果:

使用缩进可以表示多级列表

示例:

效果:

如果你不想使用有序列表,在点.之前要加上反斜杠\

示例:

效果:

1.6 超链接

超链接的文本用方括号[]括起来。

超链接可以位于一行文本之中,位于文本行中的超链接,其链接要用小括号()括起来。

示例:

效果:

超链接也可以作为引用参考放在文本的末尾,方括号[]之间不能有空格 。链接的定义可以放在空行之后的任何地方,但通常放在一个段落的底部。定义标识符可以由字母、数字、空格和标点符号组成,它们不区分大小写。

示例:

效果:

链接可以有一个描述,也可以没有。这个描述将在鼠标悬停在超链接文字上时显示。

示例:

效果:

相对路径也可以使用。

示例:

效果:

在某些Markdown版本中,除非加上尖括号<>,否则路径可能不会成为链接。

示例:

效果:

1.7 图片

图片和超链接很像,只是在方括号[]之前多了一个感叹号!,其他语法相同。需要注意的是,图片的方括号[]内可以留空。

示例:

效果:

1.8 代码块

代码块内的每个字符与键入的字符完全相同。

要在一行文本内引用代码,可以把用反引号`包括起来。

示例:

效果:

若要建立单独的代码块,则要在代码块的上下两行分别输入三个反引号`,或者分别缩进四个空格 或一个制表符Tab。若使用缩进的方式,则代码块将持续直到到达未缩进的行。

示例:

效果:

使用三个反引号`建立代码块时,在代码块上面的三个反引号后面加上语言名称可以实现代码高亮显示。

示例:

效果:

1.9 分割线

使用三个连字符-或星号*创建分割线。

示例:

效果:

1.10 表格

使用一根竖线来分隔各个单元格,使用冒号来决定单元格的对齐方向,冒号在左边表示左对齐,右边表示右对齐,两边都有表示居中。

示例:

效果:

1.11 支持的HTML元素

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等。

示例:

效果:

2. 常用技巧

2.1 缩进字符

不断行的空白字符 &nbsp; 或 &#160;
半角的空格 &ensp; 或 &#8194;
全角的空格 &emsp; 或 &#8195;

示例:

效果:

2.2 特殊符号

Markdown语法中的符号前加反斜线可显示符号本身。

示例:

效果:

其他特殊符号可使用HTML代码。

示例:

效果:

若想了解更多可查阅Unicode字符百科

2.3 字体,字号与颜色

Markdown本身不支持修改字体、字号与颜色等功能,但我们可以借助HTML实现这些项目的修改。

示例:

效果:

注: Size为规定文本的尺寸大小。可能的值:从 1 到 7 的数字。浏览器默认值是 3

2.4 内容目录

一般文章开头加上[TOC]就可以显示全文内容的目录结构。(某些Markdown版本不支持)

你也可以使用列表+超链接的方式手动制作目录。

示例:

效果:

2.5 Emoji

emoji表情使用:EMOJICODE:的格式。(此功能许多Markdown工具或者网站不支持)

可查阅Emojipedia

示例:

效果:

3. 高级语法

这些语法许多软件或网站不支持,不过还是值得介绍。

3.1 LaTeX公式

行内LaTeX公式,用一对$包括起来。

示例:

效果:

行间LaTeX公式,用两对$包括起来

示例:

效果:

3.2 流程图

具体语法参考用markdown来画流程图

示例:

效果:

3.3 待办事宜

示例:

效果:

3.4 序列图

示例:

效果:

3.5 甘特图

示例:

效果:


文章作者: 10n31y9047
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 10n31y9047 !
  目录