Obsidian Basic Formatting
SOURCE - Basic formatting syntax - Obsidian Help
Learn how to apply basic formatting to your notes, using Markdown. For more advanced formatting syntax, refer to Obsidian-Advanced-Formatting.
Paragraphs¶
To create paragraphs, use a blank line to separate one or more lines of text.
Multiple blank spaces
Multiple adjacent blank spaces in and between paragraphs collapse to a single space when displaying a note in Reading view and on Obsidian Publish sites.
Multiple adjacent spaces
and multiple newlines between paragraphs.
If you want to add multiple spaces, you can add
(blank space) and <br>
(newline) to your note.
Headings¶
To create a heading, add up to six #
symbols before your heading text. The number of #
symbols determines the size of the 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
Bold, Italics, Highlights¶
Text formatting can also be applied using Editing shortcuts.
Style | Syntax | Example | Output |
---|---|---|---|
Bold | ** ** or __ __ |
**Bold text** |
Bold text |
Italic | * * or _ _ |
*Italic text* |
Italic text |
Strikethrough | ~~ ~~ |
~~Striked out text~~ |
|
Highlight | == == |
==Highlighted text== |
Highlighted text |
Bold and nested italic | ** ** and _ _ |
**Bold text and _nested italic_ text** |
Bold text and nested italic text |
Bold and italic | *** *** or ___ ___ |
***Bold and italic text*** |
Bold and italic text |
Formatting can be forced to display in plain text by adding a backslash \
in front of it.
**This line will not be bold**
*This line will be italic and show the asterisks*
Internal Links¶
Obsidian supports two formats for internal links between notes:
- Wikilink:
[Three laws of motion](Three laws of motion.md){#22124dce27fb95658587ad0c30dd4a60}
- Markdown:
[Three laws of motion](Three%20laws%20of%20motion.md){#2f4ab4e8dd132824fb9aac14d48f7e82}
External Links¶
If you want to link to an external URL, you can create an inline link by surrounding the link text in brackets ([ ]
), and then the URL in parentheses (( )
).
You can also create external links to files in other vaults, by linking to an Obsidian URI.
Escape Blank Spaces in Links¶
If your URL contains blank spaces, you must escape them by replacing them with %20
.
You can also escape the URL by wrapping it with angled brackets (< >
).
External Images¶
You can add images with external URLs, by adding a !
symbol before an external link.
You can change the image dimensions, by adding |640x480
to the link destination, where 640 is the width and 480 is the height.
If you only specify the width, the image scales according to its original aspect ratio. For example:
Tip
If you want to add an image from inside your vault, you can also embed an image in a note.
Quotes¶
You can quote text by adding a >
symbols before the text.
> 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
Tip
You can turn your quote into a callout by adding [!info]
as the first line in a quote.
Lists¶
You can create an unordered list by adding a -
, *
, or +
before the text.
- First list item
- Second list item
- Third list item
To create an ordered list, start each line with a number followed by a .
symbol.
- First list item
- Second list item
- Third list item
Task Lists¶
To create a task list, start each list item with a hyphen and space followed by [ ]
.
- This is a completed task.
- This is an incomplete task.
You can toggle a task in Reading view by selecting the checkbox.
Tip
You can use any character inside the brackets to mark it as complete.
-
Milk
-
[?] Eggs
-
[-] Eggs
Nesting Lists¶
All list types can be nested in Obsidian.
To create a nested list, indent one or more list items:
- First list item
- Ordered nested list item
- Second list item - Unordered nested list item
Similarly, you can create a nested task list by indenting one or more list items:
- Task item 1
- Subtask 1
- Task item 2
- Subtask 1
Use Tab
or Shift+Tab
to indent or unindent one or more selected list items for easy organization.
Horizontal Rule¶
You can use three or more stars ***
, hyphens ---
, or underscore ___
on its own line to add a horizontal bar. You can also separate symbols using spaces.
Code¶
You can format code both inline within a sentence, or in its own block.
Inline Code¶
You can format code within a sentence using single backticks.
Text inside backticks
on a line will be formatted like code.
If you want to put backticks in an inline code block, surround it with double backticks like so: inline code with a backtick ` inside
.
Code Blocks¶
To format a block of code, surround the code with triple backticks.
You can also create a code block by indenting the text using Tab
or 4 blank spaces.
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
Source mode and Live Preview do not support PrismJS, and may render syntax highlighting differently.
Footnotes¶
You can add footnotes1 to your notes using the following syntax:
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 appear 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.
Note
Inline footnotes only work in reading view, not in Live Preview.
Comments¶
You can add comments by wrapping text with `inline This is a block comment.
Block comments can span multiple lines. %% ```
Backlinks:
Obsidian Advanced Formatting
You can use Obsidian-Basic-Formattingto style content within a table.
-
This is a footnote. ↩