Obsidian Markdown Reference

#markdown

Switching between source mode and editing mode:

Win: CTRL+SHIFT+C
MacOS: CMD+SHIFT+C

# Heading 1 (Appearance of Headings will differ based on theme settings)

Body

## Heading 2

Body

### Heading 3

Body

#### Heading 4

Body

##### Heading 5

Stuff

**Bold** *Italics* ~~ ~~Strikethrough~~ ~~

Highlighted text: == like this==

Quotes

> Body of the quote

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

Inline code

Text inside `backticks` on a line will be formatted like this

Code block:

```
code goes here
```

You can specify what language (js, shell, c, java, etc.)
```js
function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}
```
This is what it will look like:

function fancyAlert(arg) { 
  if(arg) { 
  	$.facebox({div:'#foo'}) 
  } 
}

Internal Link:

[Obsidian Setup]]

External link:

[[Obsidian Help]](https://help.obsidian.md)

Horizontal bar:

***
---
Renders like this:

Inline Comment

This is an comment.

Block Comments

Footnotes

This is a simple footnote[^1].
This renders like this^[1].
This is a simple footnote[^name].
This renders like this^[2].

[^1]: Footnote text.

[^name]: A named footnotes still appears as numbers, but can make it easier to identify and link references.

Callouts

Note callout

> [!note] A note callout
> Note contents

Looks like:

A note callout

Note contents

warning callout

> [!warning] Some kind of warning
> warning text

Looks like:

Some kind of warning

warning text

TLDR callout

> [!tldr] tldr: this is whats important
> this is also important

tldr: this is whats important

this is also important

Diagrams

I haven't found a lot of utility but there's some kind of diagram language called Mermaid that can be used like this:

```mermaid
sequenceDiagram
Alice->>+John: Hello John, how are you?
Alice->>+John: John can you hear me?
John-->>-Alice: Alice: Hi Alice I can hear you
John-->>-Alice: I feel grrrrrreat!
```

Looks like:

sequenceDiagram
Alice->>+John: Hello John, how are you?
Alice->>+John: John can you hear me?
John-->>-Alice: Alice: Hi Alice I can hear you
John-->>-Alice: I feel grrrrrreat!

Referencing another note

![[Obsidian Setup#Reference]]

Looks like:

Reference

Obsidian Markdown guide
My Obsidian Markdown Reference
Obsidian Community Plugins: the ones I use
Query: simple way to query your notes to view lists of things
Dataview: a flexible query language data from within your notes. Also includes ability to write JavaScript code to query things as well
Obsidian Developer Reference - more for developing your own plugin or theme

Embedded YouTube video

This often results in an error where the video just says "Watch video on YouTube"

Looks like this ↩︎
Named footnotes still appears as numbers, but can make it easier to identify and link references. ↩︎