Brain Archive

Obsidian Markdown

8分钟阅读

Obsidian支持一种拓展的Markdown语法，也叫 Obsidian Markdown

本数字花园使用Obsidian+Quartz实现， 所以所有的markdown文件也是遵循了 Obsidian Markdown 风格

Tip

也就是说 Obsidian Markdown 支持所有的标准Markdown语法

Tip

Obsidian Markdown 是 Markdown 的一种“方言”，GFM 也是 Markdown 的一种“方言”，尽管这两个标准有部分重合，但是这两种风格不一定互相兼容

双向链接

Obsidian的核心功能之一，是通过链接构建知识网络

在标准Markdown里，你只可以使用[文本](链接)来进行单向链接 (也就是链接)

Info

因为双向链接会影响这个网站的结构，所以所有下面的操作都不给出演示

而在 Obsidian 中，可以进行如下操作

基础格式

最简单的双向链接

[[Obsidian Markdown]]

这会链接到(引用)文件Obsidian Markdown

Tip

这里不仅可以用来链接其他笔记，也可以直接用来引用其他文件 例如 [[moco-logo.png]]

别名

可以在引用的时候，给笔记加入别名

[[Obsidian Markdown|Obsidian风格的Markdown]]

这个时候显示的文本就是Obsidian风格的Markdown，但是跳转到文件Obsidian Markdown

链接到标题

在进行链接的时候，可以只链接笔记的某个标题

[[Obsidian Markdown#双向链接|双向链接]]

来链接(引用)了文件Obsidian Markdown中双向链接的标题

Tip

自动生成的锚点信息可以参考下文 标题链接

链接到块

你可以通过链接到块来精确定位到一段内容

这是一个段落
^block_id
 
[[Obsidian Markdown#^block_id|^block_id]]

这样就可以精确定位到这是一个段落 这块内容

嵌入

在 Obsidian 中，可以在双向链接前加入!将其他笔记的内容直接嵌入到当前笔记中

这是一种内容复用机制，可以避免重复编写相同内容

![[页面]]           // 整篇嵌入
![[页面#标题|标题]]      // 标题
![[页面#^block|^block]]    // 块

Tip

这里不仅可以用来嵌入其他笔记，也可以直接用来嵌入附件(图片，pdf，音乐，etc) 例如 ![[moco-logo.png]]

Tip

  • [[file]] 是链接
  • ![[file]] 是嵌入

标注

在Obsidian里，对引用进行了升级，支持了新的语法

> [!note]
> 
> 这是一个note，默认就是这个(当然，你输入了一种不存在的标注也是这个)
 
> [!tip]
> 
> 这是一个tip,你可以用hint，important来表示
 
> [!abstract]
> 
> 这是一个abstract,你可以用summary，tldr来表示
 
> [!info]
> 
> 这是一个info
 
> [!todo]
> 
> 这是一个todo
 
> [!success]
> 
> 这是一个success，你可以用check，done来表示
 
> [!question]
> 
> 这是一个question，你可以用help，faq来表示
 
> [!warning]
> 
> 这是一个warning，你可以用caution，attention来表示
 
> [!failure]
> 
> 这是一个failure，你可以用fail，missing来表示
 
> [!danger]
> 
> 这是一个danger，你可以用error来表示
 
> [!bug]
> 
> 这是一个bug
 
> [!example]
> 
> 这是一个example

效果如下

Note

这是一个note，默认就是这个(当然，你输入了一种不存在的标注也是这个)

Tip

这是一个tip,你可以用hint，important来表示

Abstract

这是一个abstract,你可以用summary，tldr来表示

Info

这是一个info

Todo

这是一个todo

Success

这是一个success，你可以用check，done来表示

Question

这是一个question，你可以用help，faq来表示

Warning

这是一个warning，你可以用caution，attention来表示

Failure

这是一个failure，你可以用fail，missing来表示

Danger

这是一个danger，你可以用error来表示

Bug

这是一个bug

Example

这是一个example

自定义标题的标注

>[!tip] 这是一个提示！
> 
>你看，标题被自定义了

表现如下

这是一个提示！

你看，标题被自定义了

Tags

在markdown的正文中，你可以在任意位置加入#tag 来加入一个tag

Tip

作为标题的文本是# title，中间有个空格 作为tag的文本是#title，中间没有空格

Note

tag 支持二级标签 例如 #编程/c++ 代表着 编程“文件夹”里的c++ tag

数学公式

Obsidian支持LaTeX

$E = mc^2$
 
$$
\int x dx
$$

效果如下

图标

Obsidian支持原生渲染Mermaid的图表，放入多行代码块中就可以渲染

```mermaid
sequenceDiagram
    autonumber
    participant C as 客户端
    participant S as 服务器
 
    C->>S: SYN<br/>Seq = x
    Note over C: CLOSED → SYN-SENT
 
    S-->>C: SYN + ACK<br/>Seq = y, Ack = x + 1
    Note over S: LISTEN → SYN-RECEIVED
 
    C->>S: ACK<br/>Seq = x + 1, Ack = y + 1
    Note over C,S: 连接建立（ESTABLISHED）
```

效果如下

sequenceDiagram
    autonumber
    participant C as 客户端
    participant S as 服务器

    C->>S: SYN<br/>Seq = x
    Note over C: CLOSED → SYN-SENT

    S-->>C: SYN + ACK<br/>Seq = y, Ack = x + 1
    Note over S: LISTEN → SYN-RECEIVED

    C->>S: ACK<br/>Seq = x + 1, Ack = y + 1
    Note over C,S: 连接建立（ESTABLISHED）

注释

在Obsidian，你不仅可以使用HTML风格的注释<!-- 这是注释 -->

你可以这样写注释

%% 这是一个注释 %%

表现如下

为什么没有显示东西

因为注释不被渲染，自然看不见

和GFM兼容的特性

Info

此处为了省事，直接引用了GFM文档内的内容 以下语法来自 GitHub Markdown（GFM），Obsidian 对其提供了兼容支持

表格

表格

表格是一个多行的结构

|表头1|表头2|表头3|
|---|---|---|
|v1|v2|v3|
|v4|v5|v6|
|v7|v8|v9|

效果如下

表头1表头2表头3
v1v2v3
v4v5v6
v7v8v9

Note

表格有很多坑

表头和分隔行是必须的 第二行的 --- 是必须的，否则不会被识别成表格

表格内不能换行，如果真的需要的话，请使用html标签<br>

Tip

表格可以设置如何对其，默认情况下是左对齐

|左对齐|居中|右对齐|
|:---|:---:|---:|
|1|2|3|
|4|5|6|

效果如下

左对齐居中右对齐
123
456
指向原始笔记的链接

任务列表

任务列表

在GFM里，列表进行了加强

这是一个有序列表的任务列表
 
1. [X] 第一步
2. [x] 第二步
3. [ ] 第三步
       
这是一个无序列表的任务列表
 
- [X] 功能1
- [ ] 功能2
	- [x] 子功能1
	- [ ] 子功能2

效果如下

这是一个有序列表的任务列表

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

这是一个无序列表的任务列表

  • 功能1
  • 功能2
    • 子功能1
    • 子功能2

Tip

有几个表示完成的方法: [x] [X]，表示未完成是[ ]（中间有个空格）

Warning

为了防止出现以下和链接的冲突

- [ ] (optional) 可选功能1

请使用 \ 转义，就像下面一样

- [ ] \(optional) 可选功能
指向原始笔记的链接

代码块高亮

代码块高亮

在GFM里，多行代码块可以根据你选择的语言进行高亮

```python
print("hello world")
```

效果如下

print("hello world")

Tip

GitHub支持一种特殊的语法高亮(+开头是绿色，-开头是红色)，DIFF，使用方法如下

```diff  
+ 新增内容  
- 删除内容
```

效果如下

+ 新增内容  
- 删除内容
指向原始笔记的链接

标题链接

标题链接

在GFM里，锚点可以被自动生成

# My Title
 
[跳转](#my-title)

这样你就可以快速的跳转到文件的某个位置

Warning

本平台不支持渲染所有的GFM风格markdown，所以此处没有渲染结果

指向原始笔记的链接

脚注

脚注

GFM加入了一种新的语法，脚注。这个东西蛮容易上手的

Linqaqe[^1]: ciallo~[^2]
 
[^1]: Linqaqe 是 Moco 的好友
[^2]: ciallo~ 是柚子社女孩们常用于打招呼的问候语

效果如下

Linqaqe1: ciallo~2

Footnotes

  1. Linqaqe 是 Moco 的好友 ↩

  2. ciallo~ 是柚子社女孩们常用于打招呼的问候语 ↩

指向原始笔记的链接

拓展文本格式

高亮

这个是Obsidian独有的功能

==高亮文本== 表现为 高亮文本

删除线

删除线 (划掉)

~~删除线~~

在~~里面的字会变成 我被删了。

指向原始笔记的链接

关系图谱

反向链接