Obsidian Formatting Syntax

基于 markdown 的语法

Obsidian 本身的 notes 都是 markdown 文件，所以支持大部分的 Markdown Syntax，对一些语法有所增加，有一些语意有稍微的改变。主要的不同有下面这些。

Markdown Link 语法的增强

首先对 Markdown Syntax ❯ 链接 (Link) 增加了一种特殊种类，[[link]] 表示内部引用。当然也可以使用原本的 markdown 语法 []() 来表示。

其次类似 Markdown Syntax ❯ 图片 (Image) 的语法，可以使用 ![[note-id]] 的方法在当前笔记中嵌入其它笔记的内容。

特殊的引用标注语法 (callouts)

Callouts 是对 Markdown Syntax ❯ 引用 (Blockquote) 的增强，可以生成在笔记中生成特定样式的插注，比如 info 插注。

> [!info]
> 
> Here's a callout block.
> It supports **Markdown**, [[202404131056-markdown-syntax|Markdown Syntax]], and other.

Info

Here’s a callout block. It supports Markdown, Markdown Syntax, and other.

Callouts 也支持折叠和嵌套。

> [!faq]- Are callouts foldable? >
> 
> Yes! In a foldable callout, the contents are hidden when the callout is collapsed.
 
> [!question] Can callouts be nested?
> 
>
> > [!todo] Yes!, they can.
> >
> > > [!example] You can even use multiple layers of nesting.

Are callouts foldable?

Yes! In a foldable callout, the contents are hidden when the callout is collapsed.

Can callouts be nested?

Yes!, they can.

You can even use multiple layers of nesting.

Callouts 支持的种类。

type	aliases
abstract	summary, tldr
info
todo
tip	hint, important
question	help, faq
success	check, done
warning	caution, attention
failure	fail, missing
danger	error
bug
example
quote	cite

上下角标的实现

Obsidian 并不支持 Subscript)。如果需要有两个办法：

1. 数学公式中的脚标可以直接是用 数学符号 的方法，直接使用 $LaTeX$ 实现。
2. 使用内嵌 html 的方法实现。

X<sup>2</sup>
H<sub>2</sub>O

Example

X² H₂O

markdown 之外的增强语法

除了对于 markdown 的支持和增强之外，Obsidian 还通过使用 Mermaid 和 MathJax 增加了对图表和数学符号的支持。

图表

使用 markdown codeblock 的语法来添加 mermaid 图表。

```mermaid
sequenceDiagram
	Alice->>+John: Hello John, how are you?
	Alice->>+John: John, can you hear me?
	John-->>-Alice: Hi Alice, I can hear you!
	John-->>-Alice: I feel great!
```

Example

sequenceDiagram
	Alice->>+John: Hello John, how are you?
	Alice->>+John: John, can you hear me?
	John-->>-Alice: Hi Alice, I can hear you!
	John-->>-Alice: I feel great!

```mermaid
	graph TD
	Biology --> Chemistry
```

Example

graph TD
Biology --> Chemistry

通过图中节点添加 class 的方式可以在图中增加 obsidian 的内部连接。

Example

graph TD
Typeclass --> Monad
class Typeclass,Monad internal-link;

更多的语法的图表类型可以参照 Mermaid 的文档。

数学符号

Obsidian 支持使用 MathJax 显示使用 $LaTeX$ 编写的数学符号和公式，有两种公式显示方式，块状的公式与行内公式，分别使用 $$ 和 $ 来实现。

使用 $$ 可以添加块状的数学公式。

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

Example

$$\left|\begin{array}{cc}a& b\\ c& d\end{array}\right|=ad-bc$$

使用 $ 可添加行内的数学符号与公式。

This is an inline math expression $e^{2i\pi} = 1$.

Example

This is an inline math expression $e^{2i\pi }=1$.

更多的 $LaTeX$ 语法可以查阅在线文档 MathJax Quick Reference。或者 LaTeX Quick Reference。

注释

Obsidian 中还支持使用 `inline This is a block comment. Block comments can span multiple lines. 这段文字在预览模式中不可见。 %%