Markdown Cheat Sheet with Live Preview

Markdown is a standard writing format for developers, technical writers, and content creators. GitHub, Stack Overflow, Reddit, and many documentation platforms all use Markdown or a Markdown-like flavor.

This cheat sheet covers every Markdown syntax you need.

Headings

Use hash symbols for headings. More symbols mean smaller headings.

Text Formatting

Use double asterisks for bold text. Use single asterisks for italic text. Use triple asterisks for bold and italic. Use double tildes for strikethrough. Use backticks for inline code.

Links

Use square brackets for the text and parentheses for the URL: Link text

Images

Use an exclamation mark before square brackets with alt text, then parentheses with the image URL.

Unordered Lists

Use hyphens or asterisks followed by a space for unordered list items. Indent with two spaces for nested items.

Ordered Lists

Use numbers followed by a period and a space for ordered list items.

Task Lists

GitHub Flavored Markdown supports task lists. Use hyphen, space, then [x] for completed or [ ] for incomplete tasks.

Code Blocks

Use triple backticks with an optional language name for fenced code blocks with syntax highlighting. Supported languages include javascript, python, css, html, bash, json, typescript, go, rust, and many more.

Blockquotes

Use a greater-than sign at the start of a line for blockquotes. They can be nested by adding more greater-than signs.

Tables

Use pipes to separate columns and hyphens for the header separator row. You can align columns using colons in the separator row for left, center, or right alignment.

Horizontal Rules

Use three hyphens, three asterisks, or three underscores on a line by themselves to create a horizontal rule.

Escaping Characters

Use a backslash before a character to display it literally instead of interpreting it as Markdown syntax. This works for asterisks, hash symbols, square brackets, and many other special characters.

Markdown Flavors Are Not Identical

Markdown is not one single implementation. GitHub Flavored Markdown supports tables, task lists, autolinks, and fenced code blocks. Some documentation systems add frontmatter, MDX components, admonitions, footnotes, or custom syntax.

Before publishing important documentation, preview it in the same platform where it will be rendered. A table that works on GitHub may not work the same way in a stricter Markdown parser.

Markdown for Documentation Workflows

Markdown is especially useful because it keeps content readable before rendering. A README, changelog, API note, or troubleshooting guide should still make sense in plain text.

For documentation, focus on structure before decoration:

• use one clear H1 title
• keep heading levels sequential
• introduce code examples before showing them
• add language labels to fenced code blocks
• keep tables for actual tabular data
• use short paragraphs so diffs are easier to review

This makes Markdown easier to maintain in Git. When each paragraph is short and each section has a clear heading, reviewers can understand changes without opening a full rendered preview.

Tables, Lists, and Code Blocks

Tables are useful for comparison, but they become hard to maintain when cells contain long text. If a table is too wide, convert it into headings and bullet lists instead.

Lists work best when every item follows the same grammatical shape. Mixing long paragraphs, short fragments, and nested lists can make Markdown harder to scan.

For code blocks, always use a language label when possible:

```bash
npm run build
```

The label helps syntax highlighting and tells readers what environment the snippet belongs to.

Writing Better Technical Markdown

Readable Markdown is not only about syntax. A good document should have a clear heading structure, short paragraphs, consistent list formatting, and code fences with language labels.

For example:

```json
{
  "tool": "Markdown Preview"
}
```

The language label helps syntax highlighting and makes code examples easier to scan.

Where Markdown Is Used

Preview Markdown in Real Time

Writing Markdown blind is frustrating. Use our free Markdown Preview tool to write on the left and see the rendered HTML on the right instantly in your browser. It supports syntax highlighting, tables, and all standard Markdown features.

Common Markdown Mistakes

• Skipping heading levels, such as jumping from H2 to H4
• Forgetting blank lines before lists or code blocks
• Using tables for layout instead of data
• Leaving unclosed code fences
• Pasting smart quotes into code examples
• Assuming every platform supports the same extensions

Preview Before Publishing

A live preview is not only for beginners. It helps catch subtle issues such as broken tables, missing blank lines, unclosed code fences, incorrect heading levels, and links that do not render as expected.

Preview is also helpful when writing MDX or static site content. Frontmatter, imports, and embedded components can change how a Markdown file behaves. If the rendered page is public, check both the raw text and the final preview before publishing.

Conclusion

Markdown is simple enough to learn in 10 minutes but powerful enough for full technical documentation. Start with the basics and add tables, code blocks, and task lists as needed. Practice with our live preview tool and you will be writing clean documentation in no time.

Related Guides

• SQL formatter guide helps when documentation includes readable database examples.
• Text diff checker guide is useful when reviewing documentation edits.
• Browse related utilities in the Code Formatting Tools collection.

Related QuickToolFlow Tools

• Markdown Preview for writing and previewing Markdown side by side.
• Word Counter for checking article length and reading time.
• Text Diff Checker for comparing documentation revisions.