Writing documentation that looks beautiful
Markdown is a lightweight syntax for writing formatted text that converts cleanly to HTML. Born in 2004 as a simpler alternative to HTML and rich-text editors, Markdown dominates technical writing: README files on GitHub, documentation sites like GitBook, blog platforms like Medium, and note-taking apps like Obsidian. The syntax is intuitive—bold is **text**, italics is *text*, headings are # prefixed—so Markdown is readable even as plain text before rendering. This tool shows the conversion live: type markdown on one side, see rendered HTML on the other instantly.
Several flavors of Markdown exist. CommonMark is the strict standard, defining core syntax. GitHub Flavored Markdown (GFM) adds tables, strikethrough, and task lists, making it popular for documentation. Other flavors add footnotes, definition lists, or math support. This tool uses GFM, supporting nearly all common features developers expect.
Markdown syntax essentials
- Headings:
# H1, ## H2, ### H3…###### H6 - Emphasis:
**bold**, *italic*, ***both*** - Lists:
- bulletor1. numbered - Links:
[text](url) - Code: Inline with backticks:
`code`. Blocks with triple backticks and language:```javascript - Tables (GFM):
| Header | Header |followed by|---|---| - Blockquotes:
> quoted text - Horizontal rule:
---or***
Common Markdown use cases
- GitHub READMEs.Every repository has a README.md explaining the project. Markdown renders beautifully on GitHub's web interface.
- Documentation sites. Tools like MkDocs and Sphinx convert Markdown files into documentation websites instantly.
- Blog posts. Static site generators (Hugo, Jekyll, Gatsby) accept Markdown and output HTML blogs.
- Changelogs. Most projects maintain a CHANGELOG.md listing version history and breaking changes.
- Meeting notes and wikis. Notion, Obsidian, and other tools embrace Markdown for note-taking and knowledge bases.
Frequently asked questions
What's the difference between CommonMark and GFM?
CommonMark is the strict specification. GitHub Flavored Markdown (GFM) extends it with tables, strikethrough (~~text~~), autolinks, and task lists (- [x] done). Most tools support GFM because it's more featureful.
Can I embed HTML in Markdown?
Yes, though it's risky. A Markdown processor passes raw HTML through unchanged, but it doesn't validate it. Malformed HTML breaks the output. Most processors sanitize (strip) HTML by default for security unless configured otherwise. Use Markdown syntax when possible; reserve HTML for edge cases.
How do I escape Markdown characters?
Backslash-escape them: \*text\* renders literal asterisks instead of italics. Escaping works for *`, #, [, ], (, etc.
Is the Markdown I type here stored?
No. All preview rendering happens in your browser. Your Markdown is never sent to a server. Copy the HTML output if you need to preserve your work elsewhere.