How to use the Markdown Previewer
- Type or paste your Markdown into the editor on the left.
- The HTML preview updates in real time on the right as you type.
- Click Copy HTML to copy the rendered HTML to your clipboard.
What is Markdown?
Markdown is a lightweight markup language created by John Gruber in 2004. It is designed to be readable as plain text while converting cleanly to HTML. Today it is the standard format for README files, documentation sites, blog posts, and comments on GitHub, Stack Overflow, Reddit, and many other platforms.
Markdown syntax quick reference
| Element | Syntax |
|---|---|
| Heading 1 | # Title |
| Heading 2 | ## Subtitle |
| Bold | **bold text** |
| Italic | *italic text* |
| Link | [label](https://url) |
| Image |  |
| Inline code | `code` |
| Code block | ```language ... ``` |
| Unordered list | - item or * item |
| Ordered list | 1. item |
| Blockquote | > quoted text |
| Horizontal rule | --- |
CommonMark vs GitHub Flavored Markdown
This previewer uses the marked.js library, which follows the CommonMark specification with GitHub Flavored Markdown (GFM) extensions. GFM adds tables, task lists (- [x] done), strikethrough (~~text~~), and fenced code blocks with syntax highlighting hints.
Common use cases
- Preview a README before pushing it to GitHub or npm
- Write and test documentation for a software project
- Draft a blog post and copy the HTML to paste into a CMS
- Check how a comment or description will render on a Markdown-enabled platform