> [!info] > Sometimes I forget what the different callout boxes are, so this is my cheat sheet for all of the default formatting in Obsidian 😀 [^1] # Metadata You can add metadata to your notes by adding a block on the ==first line of your note==. The block must start and end with three hyphens (`---`). ```yaml --- cover: "https://upload.wikimedia.org/wikipedia/commons/5/54/Corvus_corone_Rabenkr%C3%A4he_2.jpg" description: Different species of crows and how to identify them. aliases: crows, corvids, corvidae permalink: crows cssclass: feathers tags: birds/corvidae, crow publish: true --- ``` |Key|Description| |---|---| |`tag`|See [Tags](https://help.obsidian.md/Editing+and+formatting/Tags).| |`tags`|Alias for `tag`.| |`alias`|See [Aliases](https://help.obsidian.md/Linking+notes+and+files/Aliases).| |`aliases`|Alias for `alias`.| |`cssclass`|Allows you to style individual notes using [CSS snippets](https://help.obsidian.md/Extending+Obsidian/CSS+snippets).| |`publish`|See [Publish and unpublish notes > Automatically select notes to publish](https://help.obsidian.md/Obsidian+Publish/Publish+and+unpublish+notes#Automatically select notes to publish).| |`permalink`|See [Publish and unpublish notes > Permalinks](https://help.obsidian.md/Obsidian+Publish/Publish+and+unpublish+notes#Permalinks).| |`description`|See [Social media link previews > Description](https://help.obsidian.md/Obsidian+Publish/Social+media+link+previews#Description).| |`image`|See [Social media link previews > Image](https://help.obsidian.md/Obsidian+Publish/Social+media+link+previews#Image).| |`cover`|See [Social media link previews > Image](https://help.obsidian.md/Obsidian+Publish/Social+media+link+previews#Image).| *(See: https://help.obsidian.md/Editing+and+formatting/Metadata)* # Headings ## Heading Two ### Heading Three #### Heading Four ##### Heading Five ###### Heading Six ```md # Heading One ## Heading Two ### Heading Three #### Heading Four ##### Heading Five ###### Heading Six ``` # Text | Text | Markdown | | --- | --- | | *italics* | `*italics*` | | **bold** | `**bold**`| | ~~strikethrough~~ | `~~strikethrough~~` | | ==highlight== | `==highlight==` | | ***bold and italic text*** | `***bold and italic text***` | | **bold text and _nested italic_ text** | `**bold text and _nested italic_ text**` | | [external link](https://help.obsidian.md/) | `[external link](https://help.obsidian.md/)` | Tags show like this: #obsidian/formatting but I usually just stick to putting tags in the frontmatter / metadata. ## Code Text inside `backticks` on a line will be formatted like code. Code blocks use three backticks and can add syntax highlighting to a code block, by adding a [language code](https://prismjs.com/#supported-languages) after the first set of backticks. ```md Text inside `backticks` on a line will be formatted like code. ``` | Syntax Highlighting | Code | | --- | --- | | markdown | md | | HTML | html | | CSS | css | | Javascript | js | | YAML | yaml | | Twig | twig | | BBCode | bbcode | # Quotes ```md > DO YOU KNOW HOW LONG I'VE BEEN LOOKING FOR YOU? \- Stuga ``` > DO YOU KNOW HOW LONG I'VE BEEN LOOKING FOR YOU? \- Stuga # Callouts Callouts can be nested and can contain other content as well. | Callout | Code | Aliases | | --- | --- | --- | | info | `> [!info]` | | | note | `> [!note]` | | | TL;DR | `> [!tldr]`| `abstract`, `summary`| | 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`| > [!info] Info: Change the first line for a custom title > Add extra content here. > [!note]- Note > Add a `-` after the callout to make it collapsible e.g. `[!note]-` > You can make a callout foldable by adding a plus (+) or a minus (-) directly after the type identifier. > A plus sign expands the callout by default, and a minus sign collapses it instead. > [!tldr]+ > This one is expanded by default because it has a `+` > [!tip] > [!success] > [!question] > [!warning] > [!failure] > [!danger] > [!bug] > [!example] > [!quote] # Lists Unordered lists use hyphens `-` - stuff - things Ordered lists use number followed by `.` 1. first thingy 2. second thingy Combinations: You can press `Tab` or `Shift+Tab` to indent or unindent one of more selected list items. 1. first thingy - stuff - things 1. part one 2. part two ## Task Lists To create a task list, start each list item with a hyphen and space followed by `[ ]`. ```md - [x] This is a completed task. - [ ] This is an incomplete task. ``` - [x] This is a completed task. - [ ] This is an incomplete task. You can toggle a task in Reading view by selecting the checkbox. # Images ``` ![Crow from Wikimedia Commons|500](https://upload.wikimedia.org/wikipedia/commons/5/54/Corvus_corone_Rabenkr%C3%A4he_2.jpg) ``` ![Crow from Wikimedia Commons|500](https://upload.wikimedia.org/wikipedia/commons/5/54/Corvus_corone_Rabenkr%C3%A4he_2.jpg) *(Image from Wikimedia Commons)* # Horizontal Rule Three hyphens `---` but not directly below text or it will turn it into a header. Or just use three ~~asteriskes. Asterisk?~~ asterisks `***`. TIL I've been spelling it wrong as *asterix*. *** # Comments You can add comments by wrapping text with `%%`. Comments are only visible in Editing view. %%haha you can't see me%%. ```md This is an %%inline%% comment. %% This is a block comment. Block comments can span multiple lines. %% ``` # Embeds Website embeds: ```html <iframe src="https://obsidian.md" width=600px height=400px></iframe> ``` <iframe src="https://obsidian.md" width=600px height=400px></iframe> ## YouTube ```md ![](https://www.youtube.com/watch?v=ml7bK1jg69I) ``` ![](https://www.youtube.com/watch?v=ml7bK1jg69I) ## Tweets To embed a tweet, use the same Markdown syntax as [external images](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#External images): ```md ![](https://twitter.com/obsdmd/status/1580548874246443010) ``` ![](https://twitter.com/obsdmd/status/1580548874246443010) # Footnotes You can add footnotes[^1] to your notes using the following syntax: ```md This is a simple footnote[^1]. [^1]: This is the referenced text. [^2]: Add 2 spaces at the start of each new line. This lets you write footnotes that span multiple lines. [^note]: Named footnotes still appears as numbers, but can make it easier to identify and link references. ``` You can also inline footnotes in a sentence. Note that the caret goes outside the brackets. ```md You can also use inline footnotes. ^[This is an inline footnote.] ``` [^1]: The majority of this page has been copied from the [Obsidian Help pages](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax) # Further Reading & Examples - https://help.obsidian.md/Editing+and+formatting/Advanced+formatting+syntax