Markdown基础使用

一、关于 Markdown

1. 什么是 Markdown？

Markdown是一种轻量级标记语言，由约翰·格鲁伯创建。它使用简单的文本格式编写文档，这些文档可以转换成结构化的HTML（超文本标记语言）。这种语言借鉴了电子邮件中纯文本标记的特性，便于阅读和编写，同时能够生成良好的网页布局。

2. 为什么要用 Markdown？

Markdown由于其简洁、易读的特性，已经成为撰写文档的首选方式之一。它允许用户专注于内容而不是格式，同时保持了文档的可读性和可移植性。此外，Markdown文件是纯文本，可以轻松地进行版本控制，并且被广泛支持在如GitHub等平台上。

3. 怎么用 Markdown？（编辑软件）

Markdown文件可以使用任何文本编辑器创建，但为了提高效率，许多程序员和作家倾向于使用提供Markdown预览和语法高亮的编辑器。一些流行的Markdown编辑器包括Visual Studio Code、Sublime Text、Atom，以及在线工具如MarkdownPad和Typora。

二、标题

1. 常用标题写法

在Markdown中，标题通过在行首添加不同数量的井号(#)来创建，井号表示标题的级别，从#（标题1）到######（标题6）。

2. 可选标题写法

除了使用井号，标题还可以使用等号(=)和连字符(-)作为标题下方的下划线来创建，等号用于一级标题，连字符用于二级标题。

3. 自定义标题 ID

Markdown允许你为标题添加一个自定义的ID，这对于链接到特定部分的文档非常有用。自定义ID通过在标题下方添加花括号包含的ID名来实现。

4. 注意事项

在使用标题时，大多数Markdown解析器要求在井号和标题文本之间有一个空格。此外，标题后的空格和井号通常被忽略，但为了兼容性，建议保留它们。

三、段落

段落是由一个或多个连续的文本行组成，前后通常至少有一个空格或一个空行。段落内的文本将按照正常的文本流显示，没有特殊的格式。

四、换行

在Markdown中，两个空格加换行或HTML的<br/>标签可以强制换行。由于直接在行尾添加空格在大多数编辑器中不可见，使用<br/>标签是更清晰和兼容性更好的方法。

五、字体选项

1. 粗体

在文本前后添加两个星号(**)或下划线(__)可以将其设置为粗体。

2. 斜体

在文本前后添加一个星号(*)或下划线(_)可以将其设置为斜体。

3. 粗斜体

在文本前后添加三个星号(***)或下划线(___)可以将文本设置为粗斜体。

4. 删除线

在文本前后添加两个波浪号(~~)可以将其设置为带有删除线的文本。

六、列表

1. 有序列表

有序列表通过在数字后添加点和空格来创建，列表中的数字可以不按顺序排列，解析时会自动按升序重新编号。

2. 无序列表

无序列表使用短划线(-)、星号(*)或加号(+)作为列表项的标记。

3. 列表嵌套

在子列表项前添加额外的空格或制表符可以创建嵌套列表。

4. 任务列表

任务列表使用方括号包围的复选框来表示，可以在列表项前添加- [ ]表示未完成，或- [x]表示已完成。

5. 定义列表

定义列表使用两行，第一行是术语，从第二行开始是该术语的定义或描述。

七、引用

1. 引用写法

引用块通过在每行的开头使用大于号(>)和空格来创建。

2. 引用多个段落

引用可以跨越多个段落，只需在每个段落的行首添加>和空格。

3. 引用嵌套

可以在一个引用块中嵌套另一个引用块，只需在嵌套的引用前添加额外的>。

4. 引用其他元素

引用块中可以包含其他Markdown元素，如列表、链接、代码等。

八、代码块

1. 行内代码

行内代码通过使用单个反引号(`)包围代码来创建。

2. 缩进代码块

通过将每行文本缩进四个空格或一个制表符，可以创建一个缩进的代码块。

3. 围栏式代码

围栏式代码块通过在三个反引号(```)后指定语言来创建，并支持语法高亮。

九、分隔线

分隔线通过在一行中使用三个或更多的星号(*)、减号(-)或下划线(_)来创建。

十、超链接

1. 使用超链接

超链接通过[链接文本](URL)的格式来创建。

2. 自动超链接

Markdown会自动将括在尖括号<和>内的URL识别为链接。

3. 和其他元素配合

超链接可以与文字的粗体、斜体等样式结合使用。

十一、图片

1. 添加图片

图片通过![图片描述](图片路径或链接)的格式添加。

2. 带链接的图片

可以通过在图片标记中添加方括号和URL的方式来将图片嵌入到链接中。

3. 带 Title 的图片

图片可以添加Title属性，通过在链接描述后添加双引号内的Title文本来实现。

十二、内嵌 HTML

在Markdown文档中，可以自由地使用HTML标签，它们将被Markdown解析器正确解析。

十三、表格

1. 使用表格

表格通过使用竖线(|)来分隔列，使用连字符(-)来分隔表头和表体。

2. 设置表格对齐方式

通过在表头的连字符(-)后添加冒号(:)可以设置列的对齐方式。

3. 在表格中使用其他元素

表格中可以包含其他Markdown元素，如链接、代码、粗体和斜体文本。

十四、脚注

脚注通过在文本中使用[^脚注标记]来引用，在文档的底部使用[^脚注标记]: 脚注内容来定义。

十五、公式

1. 行内公式

行内公式通过在公式的两侧添加单个美元符号($)来创建。

2. 块公式

块公式通过在公式的两侧添加两个美元符号($$)来创建，它们会独占一行。

十六、图表

1. 流程图

使用mermaid代码块和流程图语法可以创建流程图。

2. 时序图

使用mermaid代码块和时序图语法可以创建时序图。

3. 类图

使用mermaid代码块和类图语法可以创建UML类图。

4. 状态图

使用mermaid代码块和状态图语法可以创建状态图。

5. 实体关系图

使用mermaid代码块和实体关系图语法可以创建ER图。

6. 用户旅行图

使用mermaid代码块和旅程图语法可以创建用户旅行图。

7. 甘特图

使用mermaid代码块和甘特图语法可以创建甘特图。

十七、注释

在HTML中，注释是通过<!--和-->包围文本来实现的，这些注释不会在浏览器中显示，但会被保留在HTML源代码中。在Markdown中，虽然标准语法不支持注释，但可以通过嵌入HTML注释的方式来添加注释。这意味着，你可以在Markdown文档中加入HTML注释，它们在Markdown渲染成HTML后不会显示给读者，但可以在HTML源代码中找到。

<!-- 这是一个HTML注释，它在Markdown渲染后的页面中不会显示 -->

十八、目录

Markdown的目录功能允许你自动生成一个目录，这个目录包括文档中的所有标题。要创建一个目录，你需要在文档顶部使用[TOC]或[toc]（可以是大写或小写）。这个目录可以链接到文档中的各个部分，使得读者可以快速跳转到感兴趣的章节。

[TOC] # 标题1 一些内容... ## 子标题1 一些内容... # 标题2 一些内容...

在Markdown渲染后，[TOC]会变成一个目录，列出所有标题和子标题，并可以点击跳转。

十九、Emoji 表情

Emoji是一种流行的视觉情感表达方式，Markdown允许你使用Emoji来丰富文档的表达。为了在Markdown中添加Emoji，你需要使用冒号:包围Emoji的名称。有许多预定义的Emoji名称可以使用，例如：

• 笑脸：:smile:
• 哭脸：:cry:
• 红心：:heart:

这些Emoji在Markdown渲染后会显示为相应的彩色图标。以下是一些示例：

我非常喜欢使用Markdown编写文档，它让文档看起来很棒！😊

在Markdown渲染后，😊会变成一个笑脸图标。

为了找到更多的Emoji，你可以查阅Emoji-cheat-sheet或使用在线的Emoji搜索工具。一些编辑器和Markdown解析器还支持GitHub风格的Emoji代码，例如使用:octocat:来显示GitHub的章鱼猫图标。