Markdown Reference

Published Nov 11, 2025 Updated Nov 13, 2025 6 min read

Comprehensive reference for markdown syntax: CommonMark (baseline), GitHub Flavored Markdown (GFM), and Obsidian callouts. Each example shows the markdown syntax and rendered result.

Markdown	Rendered Output
`# Heading 1`	Heading 1
`## Heading 2`	Heading 2
`### Heading 3`	Heading 3
`#### Heading 4`	Heading 4
`##### Heading 5`	Heading 5
`###### Heading 6`	Heading 6

Markdown	Rendered Output
`italic` or `_italic_`	italic
`bold` or `__bold__`	bold
`*bold italic*`	*bold italic*

Character	Code	Result
Hash	`\#`	#
Asterisk	`\*`	*
Underscore	`\_`	_
Backtick	\`	`
Backslash	`\\`	\
Plus	`\+`	+
Dash	`\-`	-
Bracket	`\[`	[

Entity	Code	Result
Copyright	`©`	©
Trademark	`™`	™
Registered	`®`	®
En-dash	`–`	–
Em-dash	`—`	—
Non-breaking space	` `	(space)
Less than	`<`	<
Greater than	`>`	>
Ampersand	`&`	&

Part 2: GitHub Flavored Markdown (GFM)

14. Tables

Basic Table

markdown

| Header 1 | Header 2 |
| -------- | -------- |
| Cell 1   | Cell 2   |

Preview:

Header 1	Header 2
Cell 1	Cell 2

Aligned Columns

markdown

| Left | Center | Right |
| :--- | :----: | ----: |
| A    |   B    |     C |

Preview:

Left	Center	Right
A	B	C

16. Strikethrough

Markdown	Rendered Output
`~~text~~`	~~text~~

17. Mentions and References

Markdown	Rendered Output
`@username`	Mentions a user (on GitHub)
`#123`	References an issue/PR
`org/repo#456`	References across repos

18. Autolinks

Markdown	Rendered Output
`https://example.com`	https://example.com
`user@example.com`	user@example.com

19. Fenced Code Blocks

markdown

```javascript
const x = 5;
```

Preview:

javascript

const x = 5;

Tip

You can nest code blocks by using more backticks.

markdown

````markdown
```javascript
const y = 10;
```
````

20. Footnotes

markdown

Here's a sentence with a footnote.[^1]

Another reference.[^note]

[^1]: This is the first footnote.

[^note]: Named footnotes are easier to manage in long documents.

Preview:

Here’s a sentence with a footnote.¹

Another reference.²

21. Emoji

Use :emoji_name: syntax for Slack-like emoji shortcodes:

markdown

:smile: :rocket: :+1: :tada:

Preview:

😄 🚀 👍 🎉

Tip

For a complete list of emoji shortcodes, see the Emoji Cheat Sheet.

Part 3: Obsidian Callouts

All callout types follow the syntax: > [!TYPE] Optional Title

Case Sensitivity

Obsidian officially uses lowercase callout types (e.g., > [!note]), but many implementations are case-insensitive and accept uppercase (e.g., > [!NOTE]). The examples in this guide use uppercase for consistency, but lowercase is the official Obsidian syntax.

Callout Types Reference

Type	Aliases	Purpose
`note`	—	General information
`abstract`	`summary`, `tldr`	Summaries
`info`	—	Information
`todo`	—	Action items
`tip`	`hint`, `important`	Helpful hints
`success`	`check`, `done`	Success messages
`question`	`help`, `faq`	Questions
`warning`	`caution`, `attention`	Potential issues
`failure`	`fail`, `missing`	Failures
`danger`	`error`	Serious warnings
`bug`	—	Bug reports
`example`	—	Demonstrations
`quote`	`cite`	Quotations

Customizing Callouts

Custom Titles

By default, callouts display their type name as the title (e.g., “Note”, “Warning”, “Tip”). You can override this by adding a custom title after the callout type:

markdown

> [!NOTE] Custom Title Here
> This callout will display "Custom Title Here" instead of "Note".

Preview:

Custom Title Here

This callout will display “Custom Title Here” instead of “Note”.

Collapsible Callouts

You can make callouts collapsible by adding a + or - immediately after the type identifier:

+ makes the callout expanded by default (collapsible)
- makes the callout collapsed by default (collapsible)
No symbol means the callout is not collapsible (always visible)

markdown

> [!NOTE]+ Expanded by Default
> This callout is collapsible and starts expanded.

> [!NOTE]- Collapsed by Default
> This callout is collapsible and starts collapsed.

> [!NOTE] Not Collapsible
> This callout cannot be collapsed.

Preview:

Expanded by Default

This callout is collapsible and starts expanded.

Collapsed by Default

This callout is collapsible and starts collapsed.

Not Collapsible

This callout cannot be collapsed.

Callout Preview

Note

This is a note callout. Use it for general information and additional context.

Abstract

This is an abstract callout (aliases: summary, tldr). Use it for summaries and overviews.

Info

This is an info callout. Use it for informational content and notices.

Todo

This is a todo callout. Use it for action items and tasks.

Tip

This is a tip callout (aliases: hint, important). Use it for helpful hints and best practices.

Success

This is a success callout (aliases: check, done). Use it for success messages and completed actions.

Question

This is a question callout (aliases: help, faq). Use it for questions and frequently asked questions.

Warning

This is a warning callout (aliases: caution, attention). Use it to alert users about potential issues.

Failure

This is a failure callout (aliases: fail, missing). Use it to indicate errors and failures.

Danger

This is a danger callout (alias: error). Use it for serious warnings and dangerous operations.

Bug

This is a bug callout. Use it for bug reports and known issues.

Example

This is an example callout. Use it for demonstrations and code examples.

Quote

This is a quote callout (alias: cite). Use it for quotations and cited text.

Advanced Combinations

Callouts with Lists

markdown

> [!NOTE]
> Remember these key points:
>
> - Point one
> - Point two
> - Point three

> [!DANGER]
> Before you continue:
>
> 1. Back up your data
> 2. Close all other applications
> 3. Ensure sufficient disk space

Preview:

Note

Remember these key points:

Point one
Point two
Point three

Danger

Before you continue:

Back up your data
Close all other applications
Ensure sufficient disk space

Callouts with Code

markdown

> [!EXAMPLE]
> Here's how to use the API:
>
> \`\`\`javascript
> const result = await api.fetch('/users');
> console.log(result);
> \`\`\`

Preview:

Example

Here’s how to use the API:

javascript

const result = await api.fetch('/users');
console.log(result);

Callouts with Emphasis

markdown

> [!IMPORTANT]
> This is **very important** and _cannot be ignored_.
>
> **_Seriously_**, read this carefully!

Preview:

Important

This is very important and cannot be ignored.

Seriously, read this carefully!

Compatibility

Part 1 (CommonMark): Universal - works everywhere
Part 2 (GFM): GitHub, GitLab, Obsidian, and many modern platforms
Part 3 (Obsidian): Obsidian-specific features (also work in some static site generators)

Resources

This is the first footnote. ↩
Named footnotes are easier to manage in long documents. ↩

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6