Markdown cheat sheet
| You type | You get |
|---|---|
# Heading, ## Smaller | Headings, levels 1 to 6 |
**bold**, _italic_, ~~strike~~ | bold, italic, |
[text](https://example.com) | A link |
 | An image |
- item or 1. item | Bullet or numbered list |
- [ ] todo, - [x] done | Task list with checkboxes |
> quote | A block quote |
`code` and ```js … ``` | Inline code and a code block |
| a | b | + |---|---| | A table; :---: centres a column |
--- | A horizontal line |
Writing a good README
A README is the first thing people see in your repository. A useful one answers, in this order: what the project does, how to install it, a minimal usage example, how to configure it, and how to contribute or get help. Keep the first paragraph short enough to read on a phone. Click Sample for a starting structure.
Keyboard shortcuts
- Ctrl+B bold, Ctrl+I italic, Ctrl+Shift+K link
- Tab inserts two spaces, for nested lists
- Select several lines and click a list or quote button to apply it to all of them; click again to remove it.
Convert Markdown to PDF
Click Download PDF and choose Save as PDF in the window that opens. The PDF is created by your browser's own engine, so:
- text stays sharp, selectable and searchable, and links remain clickable;
- every language and emoji prints correctly, using the fonts on your computer;
- headings stay with the text that follows them, and code blocks, table rows and images are not split across pages;
- pages are numbered, and you can pick A4, Letter or Legal paper.
The file is named after your first heading. Nothing is uploaded: the document goes straight from this page to your PDF. It's a quick way to share release notes, a README, meeting notes or documentation with people who don't use Markdown.
Safe preview
Markdown may contain raw HTML. The preview removes scripts, event handlers and other active content before showing it, so pasting a README from an unknown source can't run code in your browser. Your text is saved in this browser only and never uploaded.
Frequently asked questions
How do I convert Markdown to PDF?
Write or paste your Markdown, click Download PDF, and choose Save as PDF as the destination in the print window. The PDF keeps tables, code blocks, links and images, and the text stays selectable.
Which Markdown flavour is supported?
GitHub-flavoured Markdown (GFM): the standard CommonMark syntax plus tables, task lists, strikethrough, fenced code blocks and automatic links. What you see is close to how GitHub, GitLab and most documentation sites render it.
Is my document saved?
Yes, automatically in this browser's local storage, so it's still there when you come back. It is never sent to a server. Download it as a .md file to keep a copy.
How do I make a line break without a new paragraph?
End the line with two spaces or a backslash, or tick "Treat single line breaks as new lines" to make every line break count, as in GitHub comments.
Can I convert Markdown to HTML?
Yes. Copy HTML puts the rendered HTML on your clipboard, and Download HTML page saves a complete web page with simple, readable styling.
Does the preview support diagrams or maths?
Not yet. Mermaid diagrams and LaTeX maths are shown as code blocks.