Markdown的用法(一)

Markdown是一种轻量级标记语言，排版语法简洁，让人们更多地关注内容本身而非排版。它使用易读易写的纯文本格式编写文档，可与HTML混编，可导出 HTML、PDF 以及本身的 .md 格式的文件。因简洁、高效、易读、易写，Markdown被大量使用，如Github、Wikipedia、简书等。

在线体验一下Markdown编辑器。

标题

要创建标题，请在单词或短语前面添加井号 (#) 。 # 的数量代表了标题的级别。例如，添加三个 # 表示创建一个三级标题 (<h3>) (例如：### My Header)。

Markdown语法HTML预览效果
# Heading level 1<h1>Heading level 1</h1>

Heading level 1

## Heading level 2<h2>Heading level 2</h2>

Heading level 2

### Heading level 3<h3>Heading level 3</h3>

Heading level 3

#### Heading level 4<h4>Heading level 4</h4>

Heading level 4

##### Heading level 5<h5>Heading level 5</h5>

Heading level 5

###### Heading level 6<h6>Heading level 6</h6>

Heading level 6

段落

要创建段落，请使用空白行将一行或多行文本进行分隔。

换行

在一行的末尾添加两个或多个空格，然后按回车键,即可创建一个换行(<br>)。

换行（Line Break）用法的最佳实践

几乎每个 Markdown 应用程序都支持两个或多个空格进行换行，称为 结尾空格（trailing whitespace) 的方式，但这是有争议的，因为很难在编辑器中直接看到空格，并且很多人在每个句子后面都会有意或无意地添加两个空格。由于这个原因，你可能要使用除结尾空格以外的其它方式来换行。幸运的是，几乎每个 Markdown 应用程序都支持另一种换行方式：HTML 的 <br> 标签。

为了兼容性，请在行尾添加“结尾空格”或 HTML 的 <br> 标签来实现换行。

还有两种其他方式我并不推荐使用。CommonMark 和其它几种轻量级标记语言支持在行尾添加反斜杠 (\) 的方式实现换行，但是并非所有 Markdown 应用程序都支持此种方式，因此从兼容性的角度来看，不推荐使用。并且至少有两种轻量级标记语言支持无须在行尾添加任何内容，只须键入回车键（return）即可实现换行。

强调

通过将文本设置为粗体或斜体来强调其重要性。

粗体（Bold）

要加粗文本，请在单词或短语的前后各添加两个星号（asterisks）。如需加粗一个单词或短语的中间部分用以表示强调的话，请在要加粗部分的两侧各添加两个星号（asterisks）。

Markdown语法HTML预览效果
Markdown **粗体**语法Markdown <strong>粗体</strong>语法Markdown 粗体语法

斜体（Italic）

要用斜体显示文本，请在单词或短语前后添加一个星号（asterisk）。要斜体突出单词的中间部分，请在字母前后各添加一个星号，中间不要带空格。

Markdown语法HTML预览效果
Markdown *斜体*语法Markdown <em>斜体</em>语法Markdown 斜体语法

粗体（Bold）和斜体（Italic）

要同时用粗体和斜体突出显示文本，请在单词或短语的前后各添加三个星号。要加粗并用斜体显示单词或短语的中间部分，请在要突出显示的部分前后各添加三个星号，中间不要带空格。

Markdown语法HTML预览效果
Markdown ***粗体斜体***语法Markdown <strong><em>粗体斜体</em></strong>语法Markdown 粗体斜体语法

引用

要创建块引用，请在段落前添加一个 > 符号。

1
> 幼稚是会成长，会成熟的。只要不衰老，腐败，就好。 ——鲁迅

渲染效果如下所示：

幼稚是会成长，会成熟的。只要不衰老，腐败，就好。 ——鲁迅

多个段落的块引用

块引用可以包含多个段落。为段落之间的空白行添加一个 > 符号。

1
2
3
> 轻敌，最容易失败。 ——鲁迅
>
> 同一件事，费了苦功而达到的，也比并不费力而达到的可贵。——鲁迅的人生名言

渲染效果如下：

轻敌，最容易失败。 ——鲁迅

同一件事，费了苦功而达到的，也比并不费力而达到的可贵。——鲁迅的人生名言

嵌套块引用

块引用可以嵌套。在要嵌套的段落前添加一个 >> 符号。

1
2
> 季节不等人，一刻值千金。
>> 其实世上本没有路，走的人多了，也便成了路。——鲁迅

渲染效果如下：

季节不等人，一刻值千金。

其实世上本没有路，走的人多了，也便成了路。——鲁迅

带有其它元素的块引用

Markdown 的块引用可以包含其他元素，如列表、代码块、标题等。以下是一个示例，展示了如何在块引用中使用其他元素：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
> 这是一个块引用示例，包含了其他元素：
>
> 1. 列表项一
> 2. 列表项二
>
> \```java
> public class Example {
>     public static void main(String[] args) {
>         System.out.println("Hello, world!");
>     }
> }
> \```
>
> ### 这是一个标题
>
> 块引用可以包含各种类型的内容，使得引用的内容更加丰富。

渲染效果如下：

这是一个块引用示例，包含了其他元素：

  1. 列表项一
  2. 列表项二
1
2
3
4
5
public class Example {
    public static void main(String[] args) {
        System.out.println("Hello, world!");
    }
}

这是一个标题

块引用可以包含各种类型的内容，使得引用的内容更加丰富。

列表

可以将多个条目组织成有序或无序列表。

有序列表

要创建有序列表，请在每个列表项前添加数字并紧跟一个英文句点。数字不必按数学顺序排列，但是列表应当以数字 1 起始。

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

渲染效果如下：

  1. 第一项
  2. 第二项
  3. 第三项
1
2
3
4
5
6
1. 第一项
2. 第二项
3. 第三项
    1. 有序列表
    2. 有序列表
4. 第四项

渲染效果如下：

  1. 第一项
  2. 第二项
  3. 第三项
    1. 有序列表
    2. 有序列表
  4. 第四项

无序列表

要创建无序列表，请在每个列表项前面添加破折号 (-)、星号 (*) 或加号 (+) 。缩进一个或多个列表项可创建嵌套列表。

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

渲染效果如下：

  • 第一项
  • 第二项
  • 第三项

在列表中嵌套其他元素

要在保留列表连续性的同时在列表中添加另一种元素，请将该元素缩进四个空格或一个制表符，如下例所示：

  1. 第一项
    • 嵌套的无序列表项
    • 另一个嵌套的无序列表项
      1. 嵌套的有序列表项
      2. 另一个嵌套的有序列表项
    • 最后一个嵌套的无序列表项
  2. 第二项
    1. 嵌套的有序列表项
    2. 另一个嵌套的有序列表项

段落

1
2
3
4
5
6
7
8
- 第一项
  这是第一项的段落。

  这是第一项的段落中的第二个句子。

- 第二项
  这是第二项的段落。

渲染效果如下：

  • 第一项
    这是第一项的段落。

    这是第一项的段落中的第二个句子。

  • 第二项
    这是第二项的段落。

引用块

1
2
3
4
5
6
7
8
9
- 第一项
  > 这是第一项中的引用块。
  > 块引用可以跨越多行，并且可以包含多个段落。

  这是第一项中的其他内容。

- 第二项
  > 这是第二项中的引用块。

渲染效果如下：

  • 第一项

    这是第一项中的引用块。
    块引用可以跨越多行，并且可以包含多个段落。

    这是第一项中的其他内容。

  • 第二项

    这是第二项中的引用块。

代码块

代码块通常采用四个空格或一个制表符缩进。当它们被放在列表中时，请将它们缩进八个空格或两个制表符。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
- 第一项
  <pre><code>
  这是第一项中的代码块。
  int x = 10;
  int y = 20;
  int sum = x + y;
  System.out.println("Sum is: " + sum);
  </code></pre>

  下面是第一项中的其他内容。

- 第二项
  <pre><code>
  这是第二项中的代码块。
  String message = "Hello, world!";
  System.out.println(message);
  </code></pre>

渲染效果如下：

  • 第一项

    
这是第一项中的代码块。
int x = 10;
int y = 20;
int sum = x + y;
System.out.println("Sum is: " + sum);

    下面是第一项中的其他内容。

  • 第二项

    
这是第二项中的代码块。
String message = "Hello, world!";
System.out.println(message);

图片

1
2
3
4
5
6
7
8
9
- 第一项

  ![图片描述](https://i.lasttt.com/0.jpg)

  下面是第一项中的其他内容。

- 第二项

  ![另一张图片](https://i.lasttt.com/1.jpg)

渲染效果如下：

  • 第一项

    图片描述

    下面是第一项中的其他内容。

  • 第二项

    另一张图片

列表

你可以在有序列表中嵌套一个无序列表，反之亦然。

1
2
3
4
5
6
1. 有序列表项一
    - 无序列表项一
    - 无序列表项二
2. 有序列表项二
    - 无序列表项三
    - 无序列表项四

渲染效果如下：

  1. 有序列表项一
    • 无序列表项一
    • 无序列表项二
  2. 有序列表项二
    • 无序列表项三
    • 无序列表项四
#Markdown #md
Markdown的用法(一)
https://adain.top/post/848d49c36c4c/
作者
adain
发布于
2023年11月12日
许可协议