Markdown Preview
Type Markdown on the left. The right side shows the formatted result. HTML tags in the text are shown as text, so a README cannot run script here.
What it is for?What it is for?
Markdown is plain text with a few marks: # for a heading, - for a list, **bold**. README files, GitHub comments and changelogs use it. This page is a preview. It does not implement every CommonMark rule. Tables, footnotes and raw HTML are not turned into HTML.
What is recognised
- Headings that start with # through ######.
- Bullet lists with - or *, numbered lists with 1.
- A line that is only --- or ***, shown as a horizontal rule.
- A line starting with > as a quote.
- Fenced code between triple backticks, and inline code between single backticks.
- **bold** and *italic*.
- Links and images, only when the address starts with http:// or https://. javascript: and relative paths are not made into links.
Differences from GitHub and CommonMark
- Every line is its own paragraph. In CommonMark, lines that follow each other without an empty line join into one paragraph.
- Nested lists are not supported. An indented list item is shown as a plain paragraph.
- Underscores do not make emphasis. Use *italic* and **bold**, not _italic_ or __bold__.
- A code fence that is never closed runs to the end of the text.
So the preview is good for checking the structure and wording of a README or a comment before you post it. For the exact rendering, check it on the site where it will be published.
Why HTML is shown as text
Any HTML in the text is escaped before the Markdown is processed. A README copied from an unknown repository may contain a script tag or an onerror attribute. Here it is shown as plain text and cannot run. Links open in a new tab with rel=noopener.
It stays in the browser
Nothing is sent to a server. The text stays in this tab. If you need a URL slug from a heading, use the slug tool.