Markdown Reference Guide for Obsidian#

#

1. View Modes (Why you can’t see the code)..#

Obsidian has two main ways of displaying notes. If you see the “formatted” version (like a clickable checkbox), you are in Live Preview.

  • Toggle Code View: Press Cmd + E to switch between Editing and Reading modes.
  • Source Mode: To see the “raw” characters (like - [ ]) all the time, go to the status bar at the bottom right and select Source Mode.
  • Temporary Reveal: If you click directly on a formatted item (like a checkbox), Obsidian will temporarily reveal the code for just that line.

1. Headers#

Use # followed by a space. The number of # symbols indicates the header level.

H1 Header#

H2 Header#

H3 Header#

H4 Header#


2. Text Formatting#

Standard styling for emphasis and strike-through.

  • Bold: **Bold Text**
  • Italic: *Italic Text*
  • Bold & Italic: ***Bold & Italic***
  • Strikethrough: ~~Strikethrough~~
  • ==Highlighting==: ==Highlighted Text== (Obsidian specific)

3. Lists#

Both ordered and unordered lists.

Unordered List:

  • Item 1
  • Item 2
    • Sub-item 2.1
  • Item 3

Ordered List:

  1. First Item
  2. Second Item
  3. Third Item

Task List:

  • Unfinished Task
  • Completed Task

4. Code Blocks#

Use triple backticks for blocks and single backticks for inline code.

Inline Code: Use `command` to show sudo apt update inline.

Code Block with Syntax Highlighting:

# This is a bash code block
sudo apt update && sudo apt upgrade -y
pveperf /etc/pve

Obsidian supports standard Markdown and “Wiki-style” internal links.

  • Internal Link: [[Note Name]]
  • External Link: [Display Text](https://url.com)
  • Image: ![Image Alt Text](https://image-url.com)

6. Callouts (Obsidian Specific)#

Use these to highlight warnings, tips, or notes.

This is an info callout.

Use this for critical warnings (like SSD wear on Proxmox).

This is for helpful tips.


7. Tables#

Use pipes | and dashes - to create tables.

Service Port Description
CouchDB 5984 Database for LiveSync
Pangolin 80/443 Reverse Proxy / SSO
Proxmox 8006 Web UI

8. Blockquotes & Rules#

  • Blockquote:

“The best way to predict the future is to invent it.”

  • Horizontal Rule: Use --- on a new line.

9. Mathematical Equations (LaTeX)#

Use $ for inline and $$ for blocks.

  • Inline: $E = mc^2$
  • Block: $$ a^2 + b^2 = c^2 $$