This README editor lets you write README.md files with a live GitHub-style preview, a clickable table of contents, task lists, tables and fenced code blocks. Start from the sample README, use the toolbar or shortcuts for formatting, and download the .md file or a standalone HTML page. Your draft is saved in the browser as you type.
How to use
- Write Markdown in the editor, or drop, open or paste a .md file. A sample README is loaded to start from.
- Use the toolbar or shortcuts for bold, italic, headings, links, lists, task lists, code, quotes and tables.
- Switch to Preview to see the GitHub-style result with a clickable table of contents, or to HTML to get the generated markup.
- Copy the HTML, download a standalone styled .html page, or download the .md file.
- Supports GitHub Flavored Markdown: tables, task lists, fenced code blocks, strikethrough and autolinks. Headings get GitHub-style anchor ids.
- The HTML is sanitized, so scripts and unsafe attributes are removed from the output.
- Your draft is saved automatically in this browser and is still there when you come back.
- On wide screens, Split shows the editor and the preview side by side.
What a good README contains
A README is the first thing people see in a repository, so it should answer three questions quickly: what the project does, how to install it and how to use it. A common order is a one-line description, a short example or screenshot, installation steps, usage with a code block, configuration, how to contribute and the license. Keep the opening paragraph free of jargon; details belong further down.
Fenced code blocks with a language name (```js, ```bash) get syntax highlighting on GitHub. Relative links such as docs/setup.md work inside the repository, and images can point to files in it.
GitHub Flavored Markdown
The preview follows GitHub Flavored Markdown (GFM), a superset of the CommonMark standard. On top of headings, lists, links and emphasis it adds tables written with pipes, task lists with - [ ] and - [x], ~~strikethrough~~, automatic links for bare URLs and fenced code blocks. Every heading gets a GitHub-style anchor id, so a link like #installation jumps to the Installation section, which is what the table of contents uses.
Frequently asked questions
How do I add a table of contents to a README?
Add a list of links to your headings’ anchors, for example - [Usage](#usage); GitHub resolves them like the preview does. The preview’s clickable table of contents shows every heading and its anchor to link to.
How do I make a task list?
Start a line with - [ ] for an open task or - [x] for a done one. On GitHub, task lists in issues and pull requests can be ticked directly.
Does it support GitHub tables and code blocks?
Yes. Tables use | to separate columns and a line of dashes under the header; code blocks start and end with three backticks.
Is my draft saved?
Yes. It is saved automatically in this browser and is still there when you come back. Nothing is uploaded.
Can I get the HTML?
Yes. Switch to the HTML view to copy the generated, sanitized markup, or download a standalone styled .html page.