← home

Markdown

syntax · preview
Headings
syntaxpreview
# Heading 1
Heading 1
## Heading 2
Heading 2
### Heading 3
Heading 3
#### Heading 4
Heading 4
Alt H1 ======
Alt H1
Alt H2 ------
Alt H2
Inline Formatting
syntaxpreview
**bold**
bold
__bold__
bold (alt)
*italic*
italic
_italic_
italic (alt)
***bold italic***
bold italic
~~strikethrough~~
strikethrough
==highlight==
highlight
`inline code`
inline code
super^script^
superscript
 
non-breaking space
\*escaped\*
*escaped*
Links & Images
syntaxpreview
[label](url)
label
[label](url "title")
label + tooltip
<https://url.com>
https://url.com
[label][ref] [ref]: url
label reference style
![alt text](image.png)
⬜ alt text
![alt](img.png "title")
⬜ alt + title
[![alt](img)](url)
⬜ linked image
Lists
syntaxpreview
- item - item - item
  • item
  • item
  • item
* also unordered
  • also unordered
1. first 2. second 3. third
  1. first
  2. second
  3. third
- parent - child - grandchild
  • parent
    • child
      • grandchild
- [ ] todo - [x] done
☐ todo
☑ done
Code
syntaxpreview
`inline`
inline
```bash echo "hello" ```
echo "hello"
```php <?php echo $x; ```
<?php echo $x;
4-space indent code block
code block
~~~ tilde fences ~~~
tilde fences
Blockquotes & Breaks
syntaxpreview
> blockquote
blockquote
> outer >> nested
outer
nested
> **Note** > callout style
Note
callout style
line one (2 trailing spaces) line two
line one
line two
paragraph one paragraph two
paragraph one

paragraph two
--- or *** or ___
Tables
syntaxpreview
| Col A | Col B | |-------|-------| | val 1 | val 2 | | val 3 | val 4 |
Col ACol B
val 1val 2
val 3val 4
|:------| left |------:| right |:-----:| center
alignment via
colon placement
in separator row
Extended (GFM / Obsidian)
syntaxpreview
- [x] done task - [ ] open task
☑ done task
☐ open task
~~strikethrough~~
strikethrough
word[^1] [^1]: footnote text
word[1]
¹ footnote text
==highlight==
highlight
[[WikiLink]]
WikiLink (Obsidian)
![[embed.md]]
⬜ embedded file (Obsidian)
<details> <summary>Click</summary> Hidden content </details>
Click Hidden content
```mermaid graph LR A-->B ```
Mermaid diagram
flowchart / sequence
HTML in Markdown
syntaxpreview
<br>
forced line break
<sub>sub</sub>
textsub
<sup>sup</sup>
textsup
<mark>highlight</mark>
highlight
<kbd>Ctrl</kbd>
Ctrl
<!-- comment -->
hidden, not rendered
&copy; &mdash; &rarr;
©  —  →
Tips & Best Practice
tipdetail
Blank line between blocks
always separate headings, lists, code from paragraphs
Consistent list marker
pick - or * and stick to it per doc
ATX headings preferred
# H1 over underline style for portability
No trailing spaces
except intentional line-break
Fenced code > indented
backtick fences allow language hint for syntax hl
Reference links
keep prose clean, collect URLs at bottom of doc
Escape with \
\* \# \[ \` \\ etc.