Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.
It's very easy to make some words bold and other words italic with Markdown. You can even link to Google!.
Sometimes you want bullet points:
- Start a line with a star
- Profit!
If you want to embed images, this is how you do it:
Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a # to create headings. Multiple ## in a row denote smaller heading sizes.
You can use one # all the way up to ###### six for different heading sizes.
If you'd like to quote someone, use the > character before the line:
Coffee. The finest organic suspension ever devised... I beat the Borg with it.
- Captain Janeway
And if you'd like to use syntax highlighting, include the language:
if (isAwesome){
return true
}GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath — love your sweater!
But I have to admit, tasks lists are my favorite:
- This is a complete item
- This is an incomplete item
And, of course emoji! ✨ 🐫 💥