Write a GitHub README in Markdown
Draft and preview your GitHub repository README with live Markdown rendering.
Welcome to the Markdown Editor
Write Markdown on the left, see the live preview on the right.
Features
- Bold, italic, and
strikethrough Inline codeand fenced code blocks- Links
- Lists, blockquotes, tables, and more
Code example
function greet(name) {
return `Hello, ${name}!`;
}Markdown was created by John Gruber in 2004 to make writing for the web easier.
| Feature | Supported |
|---|---|
| Headings | ✓ |
| Lists | ✓ |
| Tables | ✓ |
| Code | ✓ |
Markdown cheatsheet
GitHub tips
GitHub renders README.md files directly on the repository page. Use headings, code blocks, and lists to make your project easy to understand.
Start with a clear one-line description, then add installation, usage, and contributing sections. Use ## for sections and ### for subsections.
Code blocks with language hints (```javascript) get syntax highlighting on GitHub. Always specify the language for code samples.
Add shields.io badges at the top: [](LICENSE). Copy the HTML or Markdown from shields.io.
Conas a Oibríonn sé
Cén fáth ár gceann a úsáid?
Also check out…
Write API Documentation in Markdown
Draft endpoint descriptions, request/response exam
Take Markdown Notes
Write structured notes in Markdown that can be pas
Write Technical Documentation
Write and preview API docs, wikis, and technical g
Write Blog Posts in Markdown
Draft blog posts in Markdown for Ghost, Jekyll, Hu