一小时快速掌握Markdown文档编写

您所在的位置:网站首页 markdown缩进一个制表符 一小时快速掌握Markdown文档编写

一小时快速掌握Markdown文档编写

2023-03-30 13:11| 来源: 网络整理| 查看: 265

1、Markdown基础语法(约20分钟) 标题

应用

标题用于对文档进行结构化分组,使其易于阅读和导航。通常标题用于分隔文档的主要部分和子部分,并显示在目录中 ,

标题在文档中很常见,因为它们可以帮助读者快速了解文档的内容和结构。此外,标题还用于创建目录或导航菜单。如果使用Markdown编辑器或阅读器,标题级别通常会在菜单或导航栏中显示,以便用户更轻松地浏览文档

使用语法

在Markdown中,#符号表示标题级别,从1到6级别不同。一级标题使用一个#号,二级标题使用两个#号,以此类推。在语法中,标题的#号和标题文字之间必须有一个空格。

# 这是一级标题 ## 这是二级标题 ### 这是三级标题 #### 这是四级标题 ##### 这是五级标题 ###### 这是六级标题 复制代码

示例效果

这是一级标题 {#biaoti-one} 这是二级标题 这是三级标题 这是四级标题 这是五级标题 这是六级标题

####### 标题7(无法识别,至多到级别6)

段落

应用

在 Markdown 文件中,段落是指由一行或多行文本组成的连续文本块,其前后都有一个空行。

段落的作用是使文本内容更加清晰易读,避免大段文字挤在一起,使读者感到疲惫和无从下手。

段落的语法非常简单,只需要在每个段落的末尾加上一个空行即可。在 Markdown 文件中,空行是指没有任何字符的一行,或者只有空格或制表符的一行。

段落中可以包含其他的 Markdown 语法,比如标题、列表、代码块等。但是需要保证每个段落都要有空行与其他文本块分开。

使用语法

这是第一个段落。 这是第二个段落。 复制代码

示例效果

这是第一个段落。

这是第二个段落。

换行符

应用

在 Markdown 文件中,换行符的作用是在文本中创建一个新的行。通常情况下,文本的换行符不会被直接转换成 HTML 中的换行符(即标签),而是 需要使用特殊的语法来创建新行。需要注意的是,如果使用了其他的 Markdown 语法,比如标题、列表等,文本中的换行符可能会受到影响,需要留意排版效果。

使用语法

方式1:在一行的末尾添加两个或以上的空格,然后回车(即:在两行之间添加空行 )

这是第一行。 这是第二行。 复制代码

方式2: 直接使用 HTML 中的换行符。

这是第一行。 这是第二行。 复制代码

示例效果

方式一:

这是第一行。 这是第二行。

方式二

这是第一行。 这是第二行。

加粗

应用

加粗是一种基本的文本格式,可用于突出显示重要信息或增强文本的可读性。在Markdown中,可以使用一对星号(**)或下划线(__)将要加粗的文本包围起来 。

语法

使用一对星号(**)或下划线(__)将要加粗的文本包围起来

**这是加粗文本** __这也是加粗文本__ 复制代码

示例效果

这是加粗文本 这也是加粗文本

斜体

应用

斜体在Markdown文件中的作用是用于强调某些文字或短语。斜体会使文字变成斜体字体,使其在文本中更加明显。

语法

在要强调的文字或短语的前后加上一个或两个下划线 _ 或星号 *。如果使用单个下划线或星号,那么它们将会成对出现,表示斜体的起始和结束标记

这是一个 _斜体_ 示例。 这也是一个 *斜体* 示例。 复制代码

示例效果

这是一个 斜体 示例。 这也是一个 斜体 示例。

加粗斜体

应用

在Markdown中,斜体和加粗可以同时使用,以突出显示重要信息或引用。 要使文本同时变为斜体和粗体,在文本前后添加3个星号(*)或下划线(_)

语法:

文本前后添加3个星号(*)或下划线(_) 复制代码 ***加粗斜体文本*** ___这也是一段加粗斜体文本___ 复制代码

示例效果

加粗斜体文本 这也是一段加粗斜体文本

块引用

应用

块引用是Markdown文件中的一种文本格式,它可以用于引用他人的话语、文章、段落等。块引用通常用于文章中引用他人的观点、评论、文章摘录等,以突出这些内容的重要性,并使其与文章的其余内容区分开来。

语法

使用>号来创建

> 这是一个块引用。 > 这是引用的第二行。 复制代码

示例效果

这是一个块引用。 这是引用的第二行。

嵌套块引用

块引用可以嵌套,在要嵌套的段落前加一个 >>

语法

使用>>号来创建

> 块引用是一种在文本中突出显示引用内容的方式。它通常用于引用其他作者的文本、文章、书籍、网页等等,以及引用自己之前写过的内容。 >> 块引用通常以一种明显不同于正文的格式呈现,比如使用不同的缩进、字体、颜色或者背景色。在大多数情况下,块引用还会在被引用的内容前面添加一些特定的符号,如大于号(>) 复制代码

示例效果

块引用是一种在文本中突出显示引用内容的方式。它通常用于引用其他作者的文本、文章、书籍、网页等等,以及引用自己之前写过的内容。

块引用通常以一种明显不同于正文的格式呈现,比如使用不同的缩进、字体、颜色或者背景色。在大多数情况下,块引用还会在被引用的内容前面添加一些特定的符号,如大于号(>)

块引用和其他元素

块引用可以包含其他 Markdown 格式的元素

示例

这是标题3

要点1

要点2

这是一段斜体并且基础的文字

有序列表

应用

有序列表是Markdown文件中的一种文本格式,它可以用于列举一系列项目,以数字顺序排序。同时也可以在一个有序列表中嵌套另一个有序列表或无序列表,嵌套列表的语法和普通列表一样,只需在嵌套列表前添加四个空格即可。 有序列表可以使文章更加清晰,易于阅读和理解。

语法:

使用数字后跟一个点号(.)来标记每个项目,数字的顺序决定了它们在列表中的顺序。在项目之间留空一行可以创建多个项目

1. 第一项 1. 子项一 2. 子项二 2. 第二项 * 无序子项一 * 无序子项二 3. 第三项 1. 子项一 1. 子子项一 2. 子子项二 2. 子项二 复制代码

示例效果

第一项 子项一 子项二 第二项 无序子项一 无序子项二 第三项 子项一 子子项一 子子项二 子项二 无序列表

应用

在Markdown中,无序列表可用于列举任何类型的项目,并将它们按任意顺序排列。使用无序列表可以使文章更加清晰易读,突出各个项目的重要性

语法

使用一个星号(*)、加号(+)或减号(-)来标记每个项目,它们在列表中的顺序并不重要。在项目之间留空一行可以创建多个项目

* 第一项 * 子项一 * 子项二 * 第二项 - 子项一 - 子项二 * 第三项 1. 子项一 2. 子项二 复制代码

示例效果

第一项 子项一 子项二 第二项 子项一 子项二 第三项 子项一 子项二 在列表中添加元素

要在列表中添加另一个元素同时保持列表的连续性,请将元素缩进四个空格或一个制表符

示例

段落

这是第一个列表项

这是第二个列表项

​ 我需要在第二列表项和第三列表项中添加段落

第三个列表项

块引用

这是第一个列表项

这是块引用

- 这是第二个列表项 复制代码 代码

应用

在Markdown中,代码块可用于标识任何计算机源代码或程序代码,使其更容易阅读和理解。使用代码块和行内代码可以突出显示代码示例和命令,以便更好地展示代码和其他计算机相关信息。

语法

代码块语法将代码用一对反引号(```)括起来,代码块的开头和结尾都必须独占一行。你还可以在第一行的反引号后面指定代码块的语言类型,以便正确地高亮显示代码

​```java java("Hello, java!") ​``` 复制代码

行内代码块使用单个反引号(`)将代码括起来

这是一段包含`print("Hello, World!")`的代码。 复制代码

示例效果

示例1:

java("Hello, java!") 复制代码

示例2:

这是一段包含print("Hello, World!")的代码。

转义反引号

应用

在Markdown文件中,反引号(`)用于标记行内代码,如果你需要在文本中使用反引号本身,而不是将其解释为代码标记,你可以使用反斜杠(\)来转义它。

语法

在反引号前添加一个反斜杠(\)以将其转义。

这是一个使用反斜杠转义的反引号:\` 复制代码

示例

这是一个使用反斜杠转义的反引号:`

横线

应用

在Markdown文件中,横线的作用是为文本创建分割线,以帮助划分内容或强调某些内容的重要性。横线还可以用来为不同章节的标题之间创建分隔符。

语法

在单独的一行上使用三个或以上的连字符(---)或星号(***)来创建横线。

段落一 --- 段落二 *** 段落三 复制代码

段落一

段落二

段落三

链接

应用

在Markdown文件中,链接用于将文本链接到外部或内部资源。链接可以用于引用网页、图片、PDF文件或其他文档。Markdown提供了两种类型的链接:内联链接和引用链接 ,使用内联链接可以直接在文本中创建链接,而引用链接则可以将链接URL或路径汇总在一个地方,避免文档中出现大量重复的URL或路径。

语法

内联链接

内联链接使用方括号[]将显示的链接文本括起来,紧接着是圆括号(),里面包含链接的URL或路径。你还可以在方括号内添加一个可选的title属性来提供链接的标题

[链接文本](链接URL "链接标题") 这是一个指向 [百度](https://www.baidu.com) 的链接。 复制代码

​ 链接文本 这是一个指向 百度 的链接。

引用链接

引用链接使用方括号[]将链接文本括起来,链接文本中包含一个链接标识符。在文本的任何地方,你可以使用链接标识符创建链接。链接标识符由方括号包围,后跟一个冒号和一个空格,然后是链接的URL或路径。链接的URL或路径可以放在文档的任何位置,使用引用链接可以将大量链接汇总在一个地方,并减少文档中的重复代码

[链接文本][链接标识符] ... [链接标识符]: 链接URL "链接标题" 这是一个指向 [Google][1] 的链接。 ... [1]: https://www.google.com "谷歌" 复制代码

链接文本 ...

这是一个指向 [Google][1] 的链接。 ... [1]: www.google.com "谷歌"

网址和电子邮箱地址

要快速将 URL 或电子邮件地址转换为链接,请将其括在尖括号中

[email protected]

图片

在Markdown文件中,插入图片可以使文档内容更加生动、具有吸引力,可以用于展示产品、项目的截图,配合文字更加清晰易懂。注意,图片URL需要可访问,否则无法正常显示。如果使用本地路径,则需要确保图片文件位于当前Markdown文件所在目录下。

语法

![图片描述信息](图片URL或本地路径 "图片标题") 这是一张图片: ![图片示例](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/2432984bdcbc48edad86f436e9cb74b5~tplv-k3u1fbpfcp-zoom-1.image "图片标题") 复制代码

示例效果

这是一张图片:

图片示例

学习文档:Markdown Guide

2、Markdown表格和公式(约10分钟) 表格

应用

在Markdown文件中,表格可以用于展示数据和比较不同的项。使用Markdown语法可以轻松地创建表格,并且可以添加各种样式,如对齐方式、背景颜色等

语法

使用管道符(|)和短横线(-)来创建表格的结构。在表头下一行使用竖线和表格内容对齐。

| 姓名 | 年龄 | 性别 | | --- | --- | --- | | 张三 | 25 | 男 | | 李四 | 30 | 女 | 复制代码

在表格中可以使用多种对齐方式,例如居左、居中、居右等。使用冒号(:)来指定对齐方式,单独的冒号表示居中对齐,冒号在左边表示左对齐,右边表示右对齐。

| 左对齐 | 居中对齐 | 右对齐 | | :--- | :---: | ---: | | 内容1 | 内容2 | 内容3 | | 内容4 | 内容5 | 内容6 | 复制代码

示例效果

姓名年龄性别张三25男李四30女 左对齐居中对齐右对齐内容1内容2内容3内容4内容5内容6 数学公式

应用

在Markdown文件中,可以使用LaTeX语法来插入数学公式,在数学公式中,可以使用各种LaTeX命令,例如使用\frac来表示分数,使用\sqrt来表示平方根等。Markdown支持行内公式和独立公式两种形式。

使用语法

行内公式

用于在文本中插入简单的数学公式,公式被包围在一对单个美元符号 中间。

语法: $公式$

$E=mc^2$ 复制代码

E=mc2E=mc^2E=mc2

独立公式

用于在文本独立显示一行数学公式,公式被包围在一对双个美元符号 $$ 中间。

语法: $$公式$$

$$ \sum_{i=1}^{n} i = \frac{n(n+1)}{2} $$ 复制代码 ∑i=1ni=n(n+1)2\sum_{i=1}^{n} i = \frac{n(n+1)}{2}i=1∑n​i=2n(n+1)​

学习文档:Markdown Guide - Tables 和 LaTeX Math Symbols

3、Markdown扩展语法(约15分钟) 脚注

应用

脚注在Markdown文件中的作用是为文本提供额外的解释或注释。它通常被用于对某些专业术语或者不太常见的概念进行解释,或者引用外部参考资料。

语法

1、在要添加脚注的文字后加上一个脚注符号[^footnote],方括号内的footnote可以是任何文字,它将作为脚注的标识符

2、在文本的任意位置(通常是在文末)添加一个相同标识符的脚注定义,格式为[^footnote]: footnote content,其中footnote content为脚注的具体内容

这是一段需要注明脚注的文本[^1]。 [^1]: 这是脚注的具体内容。 复制代码

示例效果

这是一段需要注明脚注的文本1。

任务列表

应用

任务列表是Markdown文件中的一种特殊语法,它可以用来在文本中添加带有复选框的任务列表。任务列表可以用于管理任务清单,完成列表中的任务后可以勾选相应的复选框,以方便地追踪进度。 在任务列表中,可以添加任意数量的任务,每个任务可以使用Markdown支持的任何格式(例如,可以添加链接、加粗、斜体等),也可以在任务列表中嵌套其他Markdown元素(例如,代码块、引用等), 需要注意的是,任务列表并不会自动跟踪任务的完成状态,仅仅只是提供一个复选框。在实际使用中,需要手动勾选或取消复选框以表示任务的完成状态 .

语法

使用- [ ]来创建未完成的任务列表,使用- [x]来创建已完成的任务列表

- [ ] 任务1 - [x] 已完成任务2 - [ ] 任务3 复制代码

示例效果

任务1 已完成任务2 任务3 标题锚点

应用

标题锚点可以让我们在Markdown文档中创建一个可链接的锚点,使得我们可以在文档内部快速跳转到指定的标题处,方便阅读和导航。它通常用于长文档或者是需要快速导航的场景

语法

在标题后面添加 {#id} 来创建锚点,其中 id 是锚点的名称,可以任意指定,但需要保证唯一性。然后,我们可以在文档中通过使用 [链接文字](#id) 的方式来链接到这个锚点

# 目录 ## 第一章 {#chapter1} ### 1.1 节点1 {#section1} ### 1.2 节点2 {#section2} ## 第二章 {#chapter2} ### 2.1 节点1 {#section3} ### 2.2 节点2 {#section4} 复制代码

示例效果

目录 第一章 {#chapter1} 1.1 节点1 {#section1} 1.2 节点2 {#section2} 第二章 {#chapter2} 2.1 节点1 {#section3} 2.2 节点2 {#section4}

跳转到第一章

表情符号

应用

表情符号在Markdown文件中通常用于表达情感、感受或者添加一些幽默元素,可以使文本更加生动有趣

语法

使用冒号 : 包裹表情符号的名称即可。例如,:smile: 将会显示为 😄

:smile: 复制代码

示例效果

表情符号语法示例效果😄:smile:😄😊:blush:😊😍:heart_eyes:😍😂:joy:😂👍:+1: 或 :thumbsup:👍🎉:tada:🎉

更多的表情符号可以参考表情符号简码列表

下标

应用

在Markdown中,下标用于在文本中表示一个数学上的下标,通常用于表示化学分子式、数学公式中的元素或数字下标等

语法

在需要下标的文本前后分别添加波浪线 ~ ,波浪线内的文本即为下标

H~2~O 表示水分子中的 2 为下标。 CO~2~ 表示二氧化碳中的 2 为下标。 复制代码

示例效果

H2O 表示水分子中的 2 为下标。 CO2 表示二氧化碳中的 2 为下标。

上标

应用

在Markdown中,上标用于在文本中表示一个数学上的上标,通常用于表示化学分子式、数学公式中的元素或数字上标等

语法

在需要上标的文本前后分别添加脱字符(^) ,脱字符内的文本即为上标

H^+^ 表示氢离子中的 + 为上标。 x^2^ 表示 x 的平方中的 2 为上标。 复制代码

示例效果

H^+^ 表示氢离子中的 + 为上标。 x^2^ 表示 x 的平方中的 2 为上标。

禁用URL自动链接

应用

在Markdown中,如果直接在文本中输入一个URL链接,Markdown会自动将其识别为一个链接,并将其转换为一个可点击的链接。

如果想要禁用URL自动链接,可以使用一对反引号`` 包住url ,这样可以防止链接被自动识别为可点击的链接

语法

这是一个URL链接:https://www.baidu.com 这是被反引号转义的URL链接:`https://www.baidu.com` 复制代码

示例效果

这是一个URL链接:www.baidu.com

这是被反引号转义的URL链接:https://www.baidu.com

学习文档:Markdown Guide - Extended Syntax

4、Markdown编辑器的使用(约15分钟)

推荐使用Typora,Typora 是一款功能强大、易于使用的 Markdown 编辑器,支持实时预览和所见即所得的编辑模式。它的特点是简洁、美观、高效,支持 Markdown 基本语法和扩展语法,并且具有许多实用的功能和快捷键。

Typora 支持 Windows、macOS 和 Linux 操作系统,并提供多种主题和样式,用户可以根据自己的喜好进行设置。它还支持导出为多种格式,如 HTML、PDF、Word 等。

除了基本的 Markdown 编辑功能,Typora 还提供了一些高级功能,如快速添加表格、图片、超链接、代码块等。它还支持一些常用的扩展语法,如任务列表、表格、脚注、流程图、时序图等,使得用户可以更加方便地编辑复杂的文档

在下载完Typora 之后,可以按照以下步骤进行一次初体验,相关语法可以参考本文

下载Typora并安装。 打开Typora,创建一个新文档。 在文档中输入一些文本,如标题、段落和列表等。尝试使用快捷键格式化文本。 使用Typora的预览模式查看文档。 学习Markdown的基础语法,如粗体、斜体、代码块、超链接和图片等。 学习Markdown的扩展语法,如任务列表、表格、脚注等。 尝试使用Typora的快捷键或菜单栏添加表格、链接、图片、代码块等元素。 学习如何使用Typora的大纲视图功能来快速导航文档。 尝试使用Typora的主题功能更改文档的外观。 尝试使用Typora的导出功能将Markdown文档导出为HTML、PDF、Word等格式

以上计划建议配合练习进行,尽量实践,这样更容易掌握Markdown的语法和使用。

祝你成功学习Markdown!

Footnotes

这是脚注的具体内容。 ↩



【本文地址】


今日新闻


推荐新闻


CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3