Markdown Previewer
Preview markdown in real-time — GitHub-flavored Markdown support
How to Use the Markdown Previewer
- Type or paste Markdown in the editor.
- The preview updates in real time.
- Click Copy HTML to copy the rendered HTML.
Supports headings, bold, italic, strikethrough, code blocks, links, images, lists, blockquotes, and horizontal rules.
What is Markdown?
Markdown is a lightweight markup language created by John Gruber in 2004. It uses plain text syntax (# for headings, ** for bold, - for lists) that converts to HTML. Markdown is the default format for GitHub READMEs, documentation sites, dev.to, Stack Overflow posts, and most modern CMSes.
Common Uses
- Previewing README.md files before committing to GitHub
- Writing and previewing documentation for Docusaurus, MkDocs, or GitBook
- Drafting blog posts for platforms that accept Markdown (dev.to, Hashnode)
- Rendering technical documentation with code blocks and tables
Frequently Asked Questions
What is the difference between standard Markdown and GitHub Flavored Markdown (GFM)?
GFM extends standard Markdown with tables, task lists (- [ ]), fenced code blocks with syntax highlighting, strikethrough (~~text~~), and autolinked URLs. Aya Corporation's previewer supports GFM.
How do I add a code block in Markdown?
Wrap code in triple backticks (```). Add a language identifier for syntax highlighting: ```javascript on the opening line. Inline code uses single backticks: `variable`.
Can I export the rendered Markdown as HTML?
Aya Corporation renders Markdown to HTML in real time. You can copy the rendered output or use the Markdown to PDF tool for a printable version.
Notes from this implementation
Rendered here, not sanitized for your site
The preview runs a Markdown parser in the page and shows the HTML. Inline HTML in the source is allowed by most Markdown flavors, which means a preview is also an HTML preview. That is useful. It is also why you do not take this preview component and drop it, unchanged, into a comment box on a site. Rendering Markdown from strangers requires a sanitizer after the parse. This tool does not claim to be that sanitizer.
Tables, fenced code, and autolinks differ between CommonMark, GitHub-flavored Markdown, and the parser in this repo. If a README looks wrong, compare one construct at a time. The PDF page is a different pipeline (Markdown to a document), not a print stylesheet of this preview.