link to a page: [[Internal link]].
embedded link to a page: ![[1d10 table (5 col)]]
http://obsidian.md - automatic! Obsidian
This text will be italic This will also be italic
This text will be bold This will also be bold
You can combine them
- Item 1
- Item 2
- Item 2a
- Item 2b
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b
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.
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
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.
- #tags, links, formatting supported
- list syntax required (any unordered or ordered list supported)
- this is a complete item
- 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 |
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]] | [[Keyboard shortcuts|hotkeys]] |
Any word wrapped with two tildes (like this) will appear crossed out.
Use two equal signs to ==highlight text==.
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 do inline math like
Obsidian uses Mermaid to render diagrams and charts. Mermaid also provides a helpful live editor.
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!
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]].