GitHub Flavored Markdown Example
The GitHub Flavored Markdown (GFM) Spec can be found here.
Alerts
Nulla semper lectus felis, in faucibus lacus dictum eget. Pellentesque mi ligula, rutrum ut tempus eget, ornare tristique diam.
Quisque mattis urna lorem, eget lobortis tellus dignissim porta.
Cras accumsan augue dui, a finibus turpis euismod vel. Pellentesque consequat dictum tellus, ut cursus enim.
Duis nunc nulla, finibus ac finibus sed, fringilla in magna.
Etiam ac nunc eget mauris rutrum tincidunt. Vivamus neque magna, semper in erat vitae, ultricies tristique ex. Etiam maximus et justo eu eleifend. Morbi eget luctus risus.
See: Basic writing and formatting syntax – Alerts (GitHub Docs)
Task Lists
Grocery list:
- apple
- banana
- orange
- pear
See: About task lists (GitHub Docs)
Emojis
😠 😢 😁 😗 😮 😃
🐜 🪲 🐈 🐕 🐟 🐌
🍎 🍌 🍒 🍇 🍋 🍓
🚑 🚌 🚗 🚀 🚕 🚚
See: https://api.github.com/emojis, emoji-cheat-sheet
Collapsed Sections
Lorem Ispum
In sed tincidunt felis. Praesent tincidunt sollicitudin risus non tristique. Nullam vitae semper ligula, et fringilla quam. Ut dignissim velit quam, nec sollicitudin ex venenatis vitae. Vivamus sapien tellus, suscipit vel laoreet eu, auctor non neque. Praesent venenatis dignissim arcu, sed egestas lectus accumsan nec.
Fusce mollis viverra tempus. Vestibulum orci felis, ultricies ut magna quis, consectetur ultrices mauris. Proin lobortis nibh eu magna fermentum porta.
See: Organizing information with collapsed sections (GitHub Docs)
footnotes
Footnote 1 link1.
Footnote 2 link2.
Duplicated footnote reference2.
Tables
| Markdown | Less | Pretty |
|---|---|---|
| Still | renders | nicely |
| 1 | 2 | 3 |
| First Header | Second Header |
|---|---|
| Content Cell | Content Cell |
| Content Cell | Content Cell |
| Command | Description |
|---|---|
| git status | List all new or modified files |
| git diff | Show file differences that haven't been staged |
| Command | Description |
|---|---|
git status | List all new or modified files |
git diff | Show file differences that haven't been staged |
| Left-aligned | Center-aligned | Right-aligned |
|---|---|---|
| git status | git status | git status |
| git diff | git diff | git diff |
| Name | Character |
|---|---|
| Backtick | ` |
| Pipe | | |
Blockquotes
Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.
Quote break.
This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.
Blockquotes can also be nested...
...by using additional greater-than signs right next to each other...
...or with spaces between arrows.