Obsidian is a Markdown-based note-taking and knowledge base app.
We currently support the formats below:
Link to a page: [[Embeds]].
Link to a page: Embeds.
Embed another file (read more about Embeds). Here's an embedded section:
![[Plugins makes Obsidian special for you]]
# 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
*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
- 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
- Item 3a
- Item 3b
![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)
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)
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)
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)
Or you can enclose the target in <>
, such as:
[Format your notes](<Format your notes>)
[Format your notes](Format%20your%20notes.md your notes>)
> 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
Text inside `backticks` on a line will be formatted like code.
Text inside backticks
on a line will be formatted like code.
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'})
}
}
```
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.
- [x] #tags, [links](), **formatting** supported
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [?] this is also a complete item (works with every character)
- [ ] this is an incomplete item
- [ ] tasks can be clicked in Preview to be checked off
- #tags, links, formatting supported
- list syntax required (any unordered or ordered list supported)
- this is a complete item
- this is also a complete item (works with every character)
- this is an incomplete item
- tasks can be clicked in Preview to be checked off
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
------------ | ------------
[[Format your notes\|Formatting]] | [[Callouts\|Callouts]]
First Header | Second Header |
---|---|
Formatting | Callouts |
Any word wrapped with two tildes (like ~~this~~) will appear crossed out.
Any word wrapped with two tildes (like this) will appear crossed out.
Use two equal signs to ==highlight text==.
Use two equal signs to highlight text.
Use three stars ***, minuses ---, or underscores ___ in a new line to produce an horizontal bar.
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]
$$\begin{vmatrix}a & b\\
c & d
\end{vmatrix}=ad-bc$$
You can also do inline math like
Obsidian uses Mathjax. You can check which packages are supported in Mathjax here.
Use %%
to enclose comments, which will be parsed as Markdown, but will not show up in the preview.
Here is some inline comments: %%You can't see this text%% (Can't see it)
Here is a block comment:
%%
It can span
multiple lines
%%
Here is some inline comments: (can't see it in preview)
Here is a block comment: (can't see it in preview either)
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.
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: > [!INFO]
.
> [!INFO]
> Here's a callout block.
> It supports **markdown** and [[Internal link|wikilinks]].
It will show up like this:
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
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
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:
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>';
}
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!
```
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"]
评论区