What Markdown is
Markdown is a plain-text way to write formatted documents. You type # for a heading, **bold** for bold and - for a list item, and a renderer turns it into HTML. README files, GitHub issues, pull requests, wikis and most documentation sites use it.
The syntax you'll use most
# Heading 1
## Heading 2
**bold**, *italic*, `inline code`
- a bullet
- another bullet
1. numbered
2. list
[a link](https://example.com)
> a quoteGitHub Flavored Markdown
GitHub Flavored Markdown (GFM) adds tables, task lists, strikethrough and automatic links to the original syntax. This previewer supports all of them, so what you see here is close to what GitHub will show.
| Tool | Status |
| -------- | ------ |
| Markdown | Done |
| HTML | Next |
- [x] finished task
- [ ] open task
~~struck out~~Is it safe to paste HTML?
Markdown allows raw HTML. Anything unsafe, such as <script> tags or onclick attributes, is removed before the preview is shown, so pasted content cannot run code on this page.