Practical guide

Preview Markdown before publishing a README or article

Use a local Markdown preview to inspect headings, lists, links, quotes, emphasis, and code blocks before sharing.

Start with a small Markdown sample

Open the Markdown Previewer and type or paste a short excerpt. Use one to three hash marks followed by a space for headings, a hyphen for a bullet, and three backticks on separate lines around a code block.

Review structure, not just appearance

Check whether headings form a useful outline, list items are parallel, code fences close correctly, and links say where they go. The preview supports common headings, ordered and unordered lists, block quotes, paragraphs, emphasis, inline code, fenced code, and HTTP(S) or email links.

Know what this lightweight renderer omits

The preview intentionally covers a practical subset of Markdown. It does not implement tables, task-list extensions, embedded HTML, images, or the full CommonMark specification. Raw HTML is shown as text rather than executed. A Git host or publishing platform may render additional syntax differently.

Check links and code before sharing

Open important links in the destination platform after publishing, and confirm that code snippets preserve indentation. A preview cannot test whether an external page exists or whether a code example runs.

Keep unpublished notes private

Rendering happens in the browser tab without an upload to this site. Your draft remains visible in the open page until you leave or refresh, so clear it on shared devices when you are done.

Try Markdown Previewer →