Obsidian Formatting

Obsidian FormattingObsidian FormattingObsidian Formatting Obsidian is a Markdown-based note-taking and knowledge base app. We currently support the formats below: Internal linking Link to a page: [[Internal link]]. Link to a page: Internal link. Embeds Embed another file (read more about Embed files). Here's an embedded section: ![[Obsidian#What is Obsidian]] First Header test Second Header second test Image: ^hqh9or Headers This is a heading 1 This is a heading 2 This is a heading 3 This is a heading 4 This is a h

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

We currently support the formats below:

Internal linking

Link to a page: [[Internal link]].

Link to a page: Internal link.

Embeds

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

![[Obsidian#What is Obsidian]]

First Header

test

Second Header

second test

Image:

^hqh9or

Headers

# 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

%% These headings use HTML to avoid cluttering the Outline/Table of contents %%

You can also use the alternative syntax for Heading 1 and Heading 2.

Heading 1
===

Heading 2
---

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

Lists

Unnumbered lists

test

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

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

Numbered Lists

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

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

Create a loose list by adding a blank line between any two list items.

- Item 1

- Item 2
- Item 3

Will look like this:

Item 1
Item 2
Item 3

Images

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

Engelbart

![[og-image.png]]

Resizing images

Example of this above image resized to 100 pixels wide:

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

Engelbart|100

or for local images

![[og-image.png|200]]

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)

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)

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)

Link to note

Escaping

If the URL contains spaces, you can escape them by replacing them with %20.

[Export options](Pasted%20image)

Export options

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

[Slides Demo](<Slides Demo>)

Slides Demo

Blockquotes

> 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

Code

Inline code

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

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

Code blocks

You can add syntax highlighting to a code block by adding a language code after the first set of backticks.

Obsidian uses Prism for syntax highlighting. For more information, refer to Supported languages.

[!note] Live Preview mode doesn't support PrismJS and may render syntax highlighting differently.

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

Task list

Syntax Description

to-do
[/] incomplete /
done x
[-] canceled -
[>] forwarded >
[<] scheduling <
[?] question ?
[!] important !
[*] star *
["] quote "
[l] location l
[b] bookmark b
[i] information i
[S] savings s
[I] idea i
[p] pros p
[c] cons c
[f] fire f
[k] key k
[w] win w
[u] up u
[d] down d

Tables

You can create tables by assembling a list of words and dividing the header from the content with hyphens, -, 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

The vertical bars at the start and end of a line are optional.

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

This results in the same table as the one above.

Tables can be justified with a colon | Another example with a long title | And another long title as a example
:----------------|-------------:|:-------------:
because of the `:` | these will be justified |this is centered

Tables can be justified with a colon	Another example with a long title	And another long title as a example
because of the `:`	these will be justified	this is centered

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

First Header | Second Header
------------ | ------------
[[Format your notes\|Formatting]]	|  [[Keyboard shortcuts\|hotkeys]]

First Header	Second Header
Formatting	hotkeys

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.

Highlighting

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

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

Horizontal Bar

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

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,¹ and here's a longer one.²

Indent paragraphs to include them in the footnote.

`{ my code }`

Add as many paragraphs as you like.

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

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

Math

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

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

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

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

To render math from LaTeX notation Obsidian uses MathJax. For more information about the syntax, refer to MathJax basic tutorial and quick reference.

For a list of supported MathJax packages, refer to The TeX/LaTeX Extension List.

Comments

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 in Reading mode)

Here is a block comment: (can't see it in Reading mode either)
%%
It can span
multiple lines
%%

Here is some inline comments: %%You can't see this text%% (can't see it in Reading mode)

Here is a block comment: (can't see it in Reading mode either) %% It can span multiple lines %%

Callouts

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

Learn more about callouts here.

> [!INFO]
> Here's a callout block.
> It supports **markdown** and [[Internal link|wikilinks]].

[!INFO] Here's a callout block. It supports markdown and wikilinks.

[!note] [!note]

[!abstract] [!abstract] [!summary] [!tldr]

[!todo] [!todo]

[!tip] [!tip] [!hint] [!important]

[!success] [!success] [!check] [!done]

[!question] [!question] [!help] [!faq]

[!warning] [!warning] [!caution] [!attention]

[!failure] [!failure] [!fail] [!missing]

[!danger] [!danger] [!error]

[!bug] [!bug]

[!example] [!example]

[!quote] [!quote] [!cite]

Diagram

Obsidian uses Mermaid to render diagrams and charts. Mermaid also provides a helpful live editor. Mermaid provides the following diagram types:

Flowchart
Sequence diagram
Class Diagram
State Diagram
Entity Relationship Diagram
User Journey
Gantt
Pie Chart
Requirement Diagram

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

```mermaid
graph TD

Biology --> Chemistry
```

graph TD

Biology --> Chemistry

Obsidian supports linking to notes in Mermaid, these links will not show up on Graph view.

```mermaid
graph TD

Biology --> Chemistry

class Biology,Chemistry internal-link;
```

graph TD

Biology --> Chemistry

class Biology,Chemistry internal-link;

An easier way to do it is the following: ^376b9d

```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"]

Developer notes

We strive for maximum capability without breaking any existing formats, therefore we use a slightly unorthodox combination of flavors of markdown. It is broadly CommonMark, with the addition of some functionality from GitHub Flavored Markdown (GFM), some LaTeX support, and our chosen embed syntax, which you can read more about at Accepted file formats.

We intentionally do not support parsing markdown syntax and blank lines within HTML blocks. This is the result of an optimization to handle very large files and to support synchronization between editing and reading mode.

Obsidian Dialog Plugin

left: Ingmar Bergman
right: Wong Kar-wai

< I will talk
> And now I will

left: Ingmar Bergman
right: Wong Kar-wai

< I will talk
> And now I will

Footnotes

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