Markdown Preview

What is Markdown Preview?

The previewer converts Markdown to HTML with GitHub-flavoured Markdown support and displays it in a sandboxed frame that cannot run scripts. It is handy for checking README files and documentation before committing.

How to use Markdown Preview

1. Paste your input into the editor above, or select Sample to load an example.
2. Select Preview Markdown. If the input cannot be processed, a message explains what to fix.
3. Use Copy or Download to take the result with you, and Clear to start again.

Example

Input

# Title

- **Bold** item
- `code` item

Output

<h1>Title</h1>
<ul>
<li><strong>Bold</strong> item</li>
<li><code>code</code> item</li>
</ul>

Practical use cases

• Draft README files
• Check documentation formatting
• Preview issue templates

Common problems

• Assuming every Markdown flavor is identical
• Embedding untrusted HTML
• Forgetting blank lines around lists

Frequently asked questions