Dev Guides

Markdown Guide

Complete Markdown syntax guide with live examples.

23 entries

Heading 1

Headings

Largest heading. Use for page titles.

Markdown

# Heading 1

Renders as

<h1>Heading 1</h1>

Heading 2

Headings

Section heading. Use for major sections.

Markdown

## Heading 2

Renders as

<h2>Heading 2</h2>

Heading 3

Headings

Sub-section heading.

Markdown

### Heading 3

Renders as

<h3>Heading 3</h3>

Bold

Emphasis

Bold text using double asterisks.

Markdown

**bold text**

Renders as

<strong>bold text</strong>

Italic

Emphasis

Italic text using single asterisks.

Markdown

*italic text*

Renders as

<em>italic text</em>

Bold + Italic

Emphasis

Combined bold and italic.

Markdown

***bold and italic***

Renders as

<strong><em>bold and italic</em></strong>

Strikethrough

Emphasis

Strikethrough text using double tildes.

Markdown

~~strikethrough~~

Renders as

<del>strikethrough</del>

Ordered list

Lists

Numbered list using integers followed by periods.

Markdown

1. First
2. Second
3. Third

Renders as

<ol><li>First</li><li>Second</li></ol>

Unordered list

Lists

Bullet list using -, *, or +. Indent 2 spaces for nesting.

Markdown

- Item one
- Item two
  - Nested item

Renders as

<ul><li>Item one</li><li>Item two</li></ul>

Task list

Lists

Checkboxes in GitHub Flavored Markdown.

Markdown

- [x] Done task
- [ ] Pending task

Renders as

✅ Done task
☐ Pending task

Inline link

Links

Create a hyperlink with display text and URL.

Markdown

[link text](https://example.com)

Renders as

<a href="...">link text</a>

Reference link

Links

Define links separately for cleaner source.

Markdown

[link text][ref]
[ref]: https://example.com

Renders as

<a href="...">link text</a>

Inline image

Links

Embed an image with alt text.

Markdown

![alt text](image.png)

Renders as

<img src="image.png" alt="alt text">

Inline code

Code

Wrap code in backticks for inline display.

Markdown

`code here`

Renders as

<code>code here</code>

Code block

Code

Fenced code block with optional language syntax highlighting.

Markdown

```javascript
const x = 1;
```

Renders as

<pre><code>const x = 1;</code></pre>

Blockquote

Blocks

Quote text using > at the start of each line.

Markdown

> This is a quote
> that spans lines

Renders as

<blockquote>This is a quote</blockquote>

Horizontal rule

Blocks

Three or more hyphens, asterisks, or underscores.

Markdown

---

Renders as

<hr>

Table

Tables

Create tables with pipes | and dashes ---.

Markdown

| Col 1 | Col 2 |
|-------|-------|
| A     | B     |

Renders as

<table>...</table>

Aligned table

Tables

Use : in separator row to align columns.

Markdown

| Left | Center | Right |
|:-----|:------:|------:|
| L    | C      | R     |

Renders as

Left / center / right aligned columns

Footnote

Extended

Add footnotes (supported in many Markdown parsers).

Markdown

Text[^1]
[^1]: Footnote content

Renders as

Text¹ → Footnote content

Definition list

Extended

Definition lists (Pandoc/extended Markdown).

Markdown

Term
: Definition text

Renders as

<dl><dt>Term</dt><dd>Definition</dd></dl>

Escape character

Extended

Use backslash to escape special Markdown characters.

Markdown

\*not italic\*

Renders as

*not italic*

HTML inline

Extended

Raw HTML is supported in most Markdown parsers.

Markdown

<mark>highlighted</mark>

Renders as

<mark>highlighted</mark>

All processing happens locally in your browser. No data is sent to any server.