It's very easy to make some world bold and the other words italic with Markdown. You can even link to Google!
Sometimes you want numbered list:
- One
- Two
- Three
Sometimes you want bullet points:
- Start a line with a start
- Profit!
Alternatively,
- Dashes work just as well
- And if you have sub point, put two space before the dash or star:
- Like this
- And this
If you want to embed images, this is how to do it:
Sometimes it's was useful to have different levels of headings to structure your documents. Start line with a #
to create headings. Multiple ##
in a row denote simpler heading sizes.
You can use one #
all the way up to ######
six for different heading size.
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
There are many different ways to style to code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: var example = true
. If you've got a longer block of code, you can indent with four space:
if (isAwesome){
return true
}
GitHub also supports something called code fencing, which allows for multiple lines without indentation:
if (isAwesome){
return true
}
And if you 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 a @ symbol: Hay @kneath — love your sweater!
But I have to admit, tasks lists are my favorite:
- This is a complete item
- This is an incomplete item
When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It work in Pull Requests, too!
And, of course emoji!
This text will be italic
This text will also be italic
This text will be bold
This text will also be bold
You can combine them
- Item 1
- Item 2
- Item 2a
- Item 2b
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b
As Kanye West said:
We're living the future so the present here is our past.
I think you should use an <addr>
element here instead.
function fancyAlert(arg) {
if(arg) {
$.facebox({div: '#foo'})
}
}
function fancyAlert(arg) {
if(arg) {
$.facebox({div: '#foo'})
}
}
def foo():
if not bar:
return True
- @mentions, #refs, links, formatting, and
tagssupported - list syntax required (any unordered or ordered list supported)
- this is a complete item
- this is an incomplete item
First Header | Second Header |
---|---|
Content from cell 1 | Content from cell 2 |
Content in the first column | Content in the second column |
16c999e8c71134401a78d4d46435517b2271d6ac mojombo@16c999e8c71134401a78d4d46435517b2271d6ac mojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
#1 mojombo#1 mojombo/github-flavored-markdown#1