markdown基本语法

Oct 04, 2024 2:54 PM
Oct 23, 2024 12:50 PM

Markdown 标题语法

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

最佳实践

不同的 Markdown 应用程序处理 # 和标题之间的空格方式并不一致。为了兼容考虑，请用一个空格在 # 和标题之间进行分隔。

✅  Do this ❌  Don't do this
# Here's a Heading #Here's a Heading

Markdown 段落

不同段落之间用用空行来分隔。

这是一个段落。

这是另一个段落。
多个空格和空行显示问题

在段落内部的多个空格和段落之间的多个空行在阅读视图中会被合并显示为一个空格和一个 空行，在 Obsidian 发布服务的站点上也是如此。

在多个相邻空格和多个段落之间进行换行，如果想要显示多个空格或空行，你可以在笔记中使用 &nbsp;（空格）和 <br>（换行）。

Markdown 粗体、斜体、高亮

格式化文本也可以使用常用快捷键

样式 语法 示例 输出 快捷键
粗体 ** ** 或 __ __ **粗体文本** 粗体文本 Ctrl+B
斜体 * * 或 _ _ *斜体文本* 斜体文本 Ctrl+I
删除线 ~~ ~~ ~~删除线文本~~ 删除线文本 /
高亮 == == ==高亮文本== 高亮文本 /
粗体和嵌套斜体 ** ** 和 _ _ **粗体和 _嵌套斜体_ 文本** 粗体和 嵌套斜体 文本 /
粗体和斜体 *** *** 或 ___ ___ ***粗体和斜体文本*** 粗体和斜体文本 /

Markdown 引用

> 人类面临着越来越复杂和紧迫的问题，他们有效应对这些问题的能力对于社会的稳定和持续发展至关重要。
>  \- 道格·恩格尔巴特，1961

人类面临着越来越复杂和紧迫的问题，他们有效应对这些问题的能力对于社会的稳定和持续发展至关重要。
- 道格·恩格尔巴特，1961

Tip

你可以通过在引用中的第一行添加 [!信息] 来将引用变成标注

Markdown 列表

无需列表

你可以在文本前加上 -、* 或 + 来创建无序列表。

- 第一条
- 第二条
- 第三条

有序列表

要创建有序列表，每行以数字加上 .+ 空格 开头。

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

任务列表

要创建任务列表，每个列表项以连字符和空格开头，后跟 [ ]。

- [x] 这是已完成的任务。
- [ ] 这是未完成的任务。

你可以在阅读视图中通过点击复选框来切换任务状态。

Tip

你可以通过在括号内添加任意字符来将任务标记为已完成状态。

- [x] 牛奶
- [?] 鸡蛋
- [-] 鸡蛋

嵌套列表

要创建嵌套列表，请缩进一个或多个列表项：

1. 第一条
   1. 有序嵌套列表项
2. 第二条
   - 无序嵌套列表项
  1. 第一条
    1. 有序嵌套列表项
  2. 第二条
    • 无序嵌套列表项

同样，你可以通过缩进一个或多个列表项来创建嵌套任务列表：

- [ ] 任务项 1
	- [ ] 子任务 1
- [ ] 任务项 2
	- [ ] 子任务 1

使用 Tab 或 Shift+Tab 来缩进或取消缩进一个或多个已选择的列表项，以便快速地组织列表。

代码

行内代码

你可以使用一对反引号在句子插入代码。

`反引号`中的文本将被格式化为代码。

反引号中的文本将被格式化为代码。

如果要在行内代码中使用反引号，请用双反引号将其包围，比如： 这是一句内部带有`反引号`的代码。

这是一句内部带有`反引号`的代码

代码块

要创建一个代码块，请用三个反引号括住代码。

```
cd ~/Desktop
```

cd ~/Desktop

你也可以通过使用 Tab 键或4个空格缩进文本来创建代码块。

    cd ~/Desktop

你可以在开头的三个反引号后添加语言名称来为代码块添加语法高亮。

```js
function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}
```

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}