此页面复制粘贴了 Markdown 官方格式示例文章,用于快速查看所有功能的渲染效果

基本格式化语法

段落

要创建段落,请使用空行来分隔。

这是一个段落。

这是另一个段落。

小标题

要创建小标题,在小标题文本前添加至多六个 # 符号。# 符号的数量决定了小标题的级别。

# 这是标题 1
## 这是标题 2
### 这是标题 3
#### 这是标题 4
##### 这是标题 5
###### 这是标题 6

这是标题 1

这是标题 2

这是标题 3

这是标题 4

这是标题 5
这是标题 6

粗体、斜体、高亮

格式化文本也可以使用编辑相关的快捷键

样式语法示例输出
粗体** **__ __**粗体文本**粗体文本
斜体* *_ _*斜体文本*斜体文本
删除线~~ ~~~~删除线文本~~删除线文本
高亮== ====高亮文本==高亮文本
粗体和嵌套斜体** **_ _**粗体和 _嵌套斜体_ 文本**粗体和 嵌套斜体 文本
粗体和斜体*** ***___ ___***粗体和斜体文本***粗体和斜体文本

如果需要将语法符号视为普通文本进行展示,需要在语法符号前加反斜杠进行转义。比如:

**这里的加粗不会真正的加粗**

\*\*这里的加粗不会真正的加粗\*\*

*这里的倾斜不会真正的倾斜*

\*This line will be italic and show the asterisks\*

内部链接

Obsidian支持两种风格的内部链接

  • Wiki 链接风格:[[运动三定律]]
  • Markdown 链接风格:[运动三定律](运动三定律.md)

外部链接

如果要链接到外部URL,可以通过在方括号([ ])中填入描述链接的文本,然后在括号中(())添加URL来创建内联链接。

[Obsidian帮助](https://help.obsidian.md)

Obsidian帮助

你也可以通过Obsidian URI创建指向其他仓库的文件的外部链接。

[笔记](obsidian://open?vault=主仓库&file=笔记.md)

在链接中转义空格

如果你的URL包含空格,必须用 %20 替换它们。

[我的 笔记](obsidian://open?vault=主仓库&file=我的%20笔记.md)

你也可以用尖括号(< >)包裹URL进行转义。

[我的 笔记](<obsidian://open?vault=主仓库&file=我的 笔记.md>)

外部图片

你可以通过在外部链接前加上 ! 符号来在笔记中插入外部图片。

![Engelbart](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg)

Engelbart

你可以通过在链接的锚文本中添加 |640x480 来更改图片尺寸,其中640是宽度,480是高度。

![Engelbart|100x145](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg)

如果只指定了宽度,图片会根据原始长宽比进行缩放。例如:

![Engelbart|100](https://history-computer.com/ModernComputer/Basis/images/Engelbart.jpg)

Tip

如果要添加来自仓库内部的图片,你也可以使用嵌入图片语法

引用

你可以在文本前加上 > 符号来引用文本。

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

人类面临着越来越复杂和紧迫的问题,他们有效应对这些问题的能力对于社会的稳定和持续发展至关重要。

- 道格·恩格尔巴特,1961

Tip

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

列表

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

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

要创建有序列表,每行以数字加上 . 开头。

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

任务列表

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

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

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

Tip

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

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

嵌套列表

Obsidian中所有类型的列表都支持嵌套。

要创建嵌套列表,请缩进一个或多个列表项:

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

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

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

使用 TabShift+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'})
  }
}

Obsidian 使用 Prism 进行语法高亮。更多信息请参阅Prism 支持的语言

Note

源码模式实时预览不支持 PrismJS,可能会以不同方式呈现语法高亮。

脚注

你可以使用以下语法向笔记中添加脚注1

这是一个简单的脚注[^1]。
 
[^1]: 这是脚注的内容文本。
[^2]: 在每一行的开头添加2个空格,
  可以编写跨越多行的脚注。
[^注释]: 可以使用非数字来命名脚注。但渲染时,脚注仍然会显示为数字。这样可以更容易地识别脚注内容。

你也可以在句子中使用行内脚注。请注意插入符号在方括号外,将脚注内容写在方括号内。

你也可以使用内联脚注。^[这是一个内联脚注。]

Note

行内脚注仅在阅读视图中有效,不适用于实时预览。

注释

你可以用 `行内 这是一个块注释。

块注释可以跨多行。 %%


# 高级格式语法

## 表格

你可以使用竖线(`|`)和短横线(`-`)来创建表格。竖线用于分隔列,短横线用于定义列标题。

```md
| 名字 | 姓氏 |
| ---- | ---- |
| 麦克斯 | 普朗克 |
| 玛丽 | 居里 |
名字姓氏
麦克斯普朗克
玛丽居里

表格两侧的竖线是可选的。

单元格不需要与列完全对齐。每个标题行至少要有两个短横线。

名字 | 姓氏
-- | --
麦克斯 | 普朗克
玛丽 | 居里

格式化表格内容

你可以使用基本格式语法来为表格内的内容添加基本样式。

第一列第二列
内部链接链接到vault内的文件。
插入文件直接嵌入库内文件

表格中的竖线

如果你想在表格中使用别名,或者在表格中调整图片大小,你需要在竖线前加上 \ 以防止符号错误识别。

第一列 | 第二列
-- | --
[[Basic formatting syntax\|Markdown 语法]] | ![[og-image.png\|200]]
第一列第二列
Markdown 语法

通过在标题行中添加冒号(:),你可以将文本左对齐、居中或右对齐。

左对齐文本 | 居中文本 | 右对齐文本
:-- | :--: | --:
内容 | 内容 | 内容
左对齐文本居中文本右对齐文本
内容内容内容

图表

你可以使用 Mermaid 语法在笔记中添加图表和流程图。Mermaid 支持多种图表,如流程图时序图时间线等。

Tip

你也可以尝试使用 Mermaid 的 在线编辑器 来帮助你在笔记中添加图表。

要添加 Mermaid 图表,创建一个 mermaid 代码块

```mermaid
sequenceDiagram
    Alice->>+John: 你好 John,你好吗?
    Alice->>+John: John,你能听到我吗?
    John-->>-Alice: 嗨 Alice,我能听到你!
    John-->>-Alice: 我感觉很好!
```
sequenceDiagram
    Alice->>+John: 你好 John,你好吗?
    Alice->>+John: John,你能听到我吗?
    John-->>-Alice: 嗨 Alice,我能听到你!
    John-->>-Alice: 我感觉很好!
```mermaid
graph TD
 
生物学 --> 化学
```
graph TD

生物学 --> 化学

在图表中添加链接

你可以通过将节点声明为 internal-link 类型 来在图表中创建内部链接

```mermaid
graph TD
 
生物学 --> 化学
 
class 生物学,化学 internal-link;
```
graph TD

生物学 --> 化学

class 生物学,化学 internal-link;

Note

图表中的内部链接不会显示在 关系图谱中。

如果你的图表中有很多节点,你可以使用以下代码片段。

```mermaid
graph TD
 
A[生物学]
B[化学]
 
A --> B
 
class A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,P,Q,R,S,T,U,V,W,X,Y,Z internal-link;
```

这样,每个字母节点都会成为一个内部链接,节点文本将作为链接文本。

Note

如果你的笔记名称中包含特殊字符,你需要将笔记名称放在双引号中。

class "⨳ 特殊字符" internal-link

或者 A["⨳ 特殊字符"]

想了解更多有关创建图表的信息,请参阅Mermaid 官方文档

数学公式

你可以使用 MathJax 和 LaTeX 符号在笔记中添加数学公式。

要在笔记中添加 MathJax 公式,请用双美元符号($$)将其括起来。

$$
\begin{vmatrix}a & b\\
c & d
\end{vmatrix}=ad-bc
$$

你也可以用 $ 符号包裹数学公式来实现行内数学公式。

这是一个行内数学表达式 $e^{2i\pi} = 1$。

这是一个行内数学表达式

想了解更多有关语法的信息,请参阅MathJax 基础教程

要查看支持的 MathJax 包列表,请参阅TeX/LaTeX 扩展列表

Footnotes

  1. 这是一个脚注。