Formation

Blockquote（块引用）

> Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.

\- Doug Engelbart, 1961

Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.

- Doug Engelbart, 1961

Callout（标注、提醒）

As of v0.14.0, Obsidian supports callout blocks, sometimes called "admonitions". Callout blocks are written as a blockquote, inspired by the "alert" syntax from Microsoft Docs.

Callouts are also be supported natively on Obsidian Publish.

Note

For compatibility reasons, if you're also using the Admonitions plugin, you should update it to at least v8.0.0 to avoid problems with the new callout system.

Use the following syntax to denote a callout block: > [!tip].

> [!tip] 
> Here's a callout block.
> It supports **markdown** and wikilinks.

It will show up like this:

Tip

Here's a callout block.
It supports markdown and wikilinks.

Types

By default, there are 12 distinct callout types, each with several aliases. Each type comes with a different background color and icon.

To use these default styles, replace INFO in the examples with any of these types. Any unrecognized type will default to the "note" type, unless they are customized. The type identifier is case insensitive.
（用于文献笔记）

note
abstract, summary, tldr（摘要）
info（文章中没有的信息）, todo
tip, hint, important（要点）
success, check, done
question, help, faq（遇到的问题）
warning, caution, attention
failure, fail, missing
danger, error（重点）
bug
example（文章中举例）
quote, cite （引用，定义）

Danger

Warning

Example

Bug

Done

Help

Tip

Abstract

Definition

Note

Inf

Todo

Quote

Fail

这里博客中 callout 的 info 背景颜色错误始终为红色 bug！待调整 #tasks

Info

Title and body

You can define the title of the callout block, and you can also have a callout without body content.

> [!TIP] Callouts can have custom titles, which also supports **markdown**!

Folding（FAQ折叠功能）

Additionally, you can create a folding callout by adding + (default expanded) or - (default collapsed) after the block.

> [!FAQ]- Are callouts foldable?
> Yes! In a foldable callout, the contents are hidden until it is expanded.

Will show up as:

Are callouts foldable?

Yes! In a foldable callout, the contents are hidden until it is expanded.

Customizations

Snippets and plugins can define custom callouts, too, or overwrite the default options. Callout types and icons are defined in CSS, where the color is an r, g, b tuple and the icon is the icon ID from any internally supported icon (like lucide-info). Alternatively, you can specify an SVG icon as a string.

.callout[data-callout="my-callout-type"] {
    --callout-color: 0, 0, 0;
    --callout-icon: icon-id;
    --callout-icon: '<svg>...custom svg...</svg>';
}

Code Block（代码块）

Syntax highlight is supported with the language specified after the first set of backticks. We use prismjs for syntax highlighting, a list of supported languages can be found at their site

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

print('Hello')
def test():
	return

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

    Text indented with a tab is formatted like this, and will also look like a code block in preview.

Text indented with a tab is formatted like this, and will also look like a code block in preview.

Comment（评论）

Use `You can't see this text%% (Can't see it)

Here is a block comment:
%%
It can span
multiple lines
You can't see this text
It can span
multiple lines
%%

Diagram（图表）

Obsidian uses Mermaid to render diagrams and charts. Mermaid also provides a helpful live editor.

```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!
```

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!

Obsidian supports linking to notes in Mermaid:

```mermaid
graph TD

Biology --> Chemistry

class Biology,Chemistry internal-link;
```

An easier way to do it is the following:

```mermaid
graph TD

A[Biology]
B[Chemistry]

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;
```

This way, all the note names (at least until Z[note name]) are all automatically assigned the class internal-link when you use this snippet.

If you use special characters in your note names, you need to put the note name in double quotes.
"⨳ special character"
It looks like this if you follow the second option:
A["⨳ special character"]

Embeds（嵌入、双链）

Embed another file (read more about Embeds). Here's an embedded section:

![[Plugins makes Obsidian special for you]]

!Plugins make Obsidian special for you

Emphasis（文字强调）

*This text will be italic*
_This will also be italic_

This text will be italic
This will also be italic

**This text will be bold**
__This will also be bold__

This text will be bold
This will also be bold

_You **can** combine them_

You can combine them

Footnotes（脚注）

Here's a simple footnote,[^1] and here's a longer one.[^bignote]

[^1]: meaningful!

[^bignote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    `{ my code }`

    Add as many paragraphs as you like.

Here's a simple footnote,^[1] and here's a longer one.^[2]

You can also use inline footnotes. ^[notice that the carat goes outside of the brackets on this one.]

You can also use inline footnotes. ^[3]

Format

Obsidian is a Markdown-based note-taking and knowledge base app.

We currently support the formats below:

Heading（标题）

# This is a heading 1
## This is a heading 2
### This is a heading 3 
#### This is a heading 4
##### This is a heading 5
###### This is a heading 6

This is a heading 1

This is a heading 2

This is a heading 3

This is a heading 4

This is a heading 5

This is a heading 6

HighLight（高亮）

Use two equal signs to ==highlight text==.

Use two equal signs to highlight text.

Horizontal divider（分割线）

Use three stars ***, minuses ---, or underscores ___ in a new line to produce an horizontal bar.

Image（图像）

![Obsidian](https://obsidian.md/images/banner.png)

Resizing images

Example of this above image resized to 200 pixels wide:

![Obsidian|200](https://obsidian.md/images/banner.png)

Inline Code（内联代码）

Text inside `backticks` on a line will be formatted like code.

Text inside backticks on a line will be formatted like code.

Internal Link（内部链接）

Link to a page: Embeds.

Link to a page: [[Embeds]].

Links

External links

Markdown style links can be used to refer to either external objects, such as web pages, or an internal page or image.

http://obsidian.md - automatic!
[Obsidian](http://obsidian.md)

http://obsidian.md - automatic!
Obsidian

Obsidian URI links

Obsidian URI links can be used to open notes in Obsidian either from another Obsidian vault or another program.

For example, you can link to a file in a vault like so (please note the required encoding):

[Link to note](obsidian://open?path=D:%2Fpath%2Fto%2Ffile.md)

Link to note

You can link to a note by its vault name and file name instead of path as well:

[Link to note](obsidian://open?vault=MainVault&file=MyNote.md)

Link to note

Escaping

If there are spaces in the url, they can be escaped by either using %20 as a space, such as:

[Format your notes](Format%20your%20notes)

Format your notes

Or you can enclose the target in <>, such as:

[Format your notes](<Format your notes>)

[Format your notes](Format%20your%20notes.md your notes>)

Lists（列表）

- Item 1
- Item 2
  - Item 2a
  - Item 2b

1. Item 1
1. Item 2
1. Item 3
   1. Item 3a
   1. Item 3b

Item 1
Item 2
- Item 2a
- Item 2b

Item 1
Item 2
Item 3
1. Item 3a
2. Item 3b

Math（数学公式）

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

| \begin{matrix} a & b \\ c & d \end{matrix} | = a d - b c

You can also do inline math like $e^{2 i π} = 1$ .

长公式显示测试
$\underset{kinetic energies and self - interactions of the gauge bosons}{\underset{⏟}{\frac{1}{4} W_{μ ν} \cdot W^{μ ν} - \frac{1}{4} B_{μ ν} B^{μ ν} - \frac{1}{4} G_{μ ν}^{a} G_{a}^{μ ν}}} and \nabla \times E = - \frac{\partial B}{\partial t} and \nabla \times H = J + \frac{\partial D}{\partial t} and e = lim_{n \to \infty} {(1 + \frac{1}{n})}^{n} and {\dot{x}}_{i} = a_{i} x_{i^{'}} - (d + a_{i 0} + a_{i 1}) x_{i} + r x_{i} (f_{i} - ϕ)$

Obsidian uses Mathjax. You can check which packages are supported in Mathjax here.

StrikeThrough（划掉）

Any word wrapped with two tildes (like ~~this~~) will appear crossed out.

Any word wrapped with two tildes (like ~~this~~) will appear crossed out.

Table（表格）

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:

First Header | Second Header
------------ | ------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

First Header	Second Header
Content from cell 1	Content from cell 2
Content in the first column	Content in the second column

Tables can be justified with a colon | Another example with a long title
:----------------|-------------:
because of the `:` | these will be justified

Tables can be justified with a colon	Another example with a long title
because of the `:`	these will be justified

If you put links in tables, they will work, but if you use Piped Links, the pipe must be escaped with a \ to prevent it being read as a table element.

First Header | Second Header
------------ | ------------
Formatting	|  Callouts

First Header	Second Header
Formatting	Callouts

Tasks（任务）

- [x] #tags, [links](), **formatting** supported [link](https://todoist.com/app/task/8179077638) #todoist 
- [x] list syntax required (any unordered or ordered list supported) [link](https://todoist.com/app/task/8179077708) 
- [x] this is a complete item [link](https://todoist.com/app/task/8179077788) 
- [?] this is also a complete item (works with every character)
- [ ] this is an incomplete item [link](https://todoist.com/app/task/8179077850) 
- [ ] tasks can be clicked in Preview to be checked off [link](https://todoist.com/app/task/8179077869)

#tags, links, formatting supported link
list syntax required (any unordered or ordered list supported) link
this is a complete item link
this is also a complete item (works with every character)
this is an incomplete item link
tasks can be clicked in Preview to be checked off link

meaningful! ↩︎
Here's one with multiple paragraphs and code.

Indent paragraphs to include them in the footnote.

{ my code }

Add as many paragraphs as you like. ↩︎
notice that the carat goes outside of the brackets on this one. ↩︎