A Quick Markdown Syntax Guide

Markdown is a lightweight way to write formatted text using plain characters. It is used for documentation, blog posts and comments because it reads naturally even before it is rendered.

Headings and emphasis

Headings start with one to six # characters. Bold uses **double asterisks**, italics use *single asterisks*, and inline code uses backticks.

# Heading
**bold** and *italic*

Links and images

[link text](https://example.com)
![alt text](https://example.com/image.png)

Lists

- unordered item
- another item

1. first
2. second

Code blocks

3
js console.log('hello')

Common pitfalls

• Leaving no blank line between a paragraph and a list, which can merge them.
• Using a single asterisk where bold is intended.
• Forgetting to escape literal # or * at the start of a line.

Frequently asked questions

• Is my document uploaded? No. A browser-based editor keeps your text local.
• Can I preview as I type? Yes, a live preview editor updates the rendered output immediately.

Need to write Markdown with instant feedback? Try the free Markdown Editor — it previews locally as you type.