Lucas Callado | Blog    About    Archive

Github Flavored Markdown Cheatsheet.

GFM is a variant of markdown developed by Github.

https://help.github.com/articles/github-flavored-markdown https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

Plain Text

Headings

Header 1
========

Header 2
--------

# H1
## H2
### H3
#### H4
##### H5
###### H6

Emphasis Emphasis (aka italics): asterisks or underscores Strong emphasis (aka bold): asterisks or underscores Combined emphasis: asterisks and underscores Strikethrough: Scratch this.

Lists In this example, leading and trailing spaces are shown with with dots: .

1. First ordered list item
2. Another item
..* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
..1. Ordered sub-list
4. And another item.

...You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).

...To have a line break without a paragraph, you will need to use two trailing spaces...
...Note that this line is separate, but within the same paragraph...
...(This is contrary to the typical GFM line break behavior, where trailing spaces are not required.)

* Unordered list can use asterisks
- Or minuses
+ Or pluses

In above \s means a "space" character

- [ ] checkbox
- [x] checked checkbox

URLs There are two ways to create links.

[text](url)	Turn text into an URL.

![alt text](URL "title")  Place an image inline.

![alt text][label]
[label]: URL "title"

[I'm an inline-style link](https://www.google.com)

[I'm an inline-style link with title](https://www.google.com "Google's Homepage")

[I'm a reference-style link][Arbitrary case-insensitive reference text]

[I'm a relative reference to a repository file](../blob/master/LICENSE)

[You can use numbers for reference-style link definitions][1]

Or leave it empty and use the [link text itself]

Some text to show that the reference links can follow later.

[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com

Images

Reference-style:	![alt text][logo]

Code Blocks Markdown converts text with four spaces at the front of each line to code blocks. GFM supports that, but we also support fenced blocks. Just wrap your code blocks in ``` and you won’t need to indent manually to trigger a code block. Keep in mind that both types of code blocks need to have a blank line before them:

```
function test()
{
	console.log("notice the blank line before this function?");
}
```

```
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
```

Syntax highlighting Code blocks can be taken a step further to add syntax highlighting if you request it. In your fenced block, add an optional language identifier and it will run it through syntax highlighting. For example, to syntax highlight Ruby code:

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

Linguist [https://github.com/github/linguist] is used to perform language
detection and syntax highlighting. You can find out which keywords are valid
by perusing the languages YAML file [https://github.com/github/linguist/blob/master/lib/linguist/languages.yml].

Tables Tables aren’t part of the core Markdown spec, but they are part of GFM and Markdown Here supports them. They are an easy way of adding tables to your email – a task that would otherwise require copy-pasting from another application.

Colons can be used to align columns.

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |

The outer pipes (|) are optional, and you don't need to make the raw
Markdown line up prettily. You can also use inline Markdown.

Markdown | Less | Pretty
--- | --- | ---
\*Still\* | `renders` | **nicely**
1 | 2 | 3

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.

Inline html You can also use raw HTML in your Markdown, and it’ll mostly work pretty well.

<dl>
  		<dt>Definition list</dt>
  		<dd>Is something people use sometimes.</dd>
<dt>Markdown in HTML</dt> <dd>Does *not* work very well. Use HTML tags.</dd>
</dl>

Horizontal Rule Three or more…

---

Hyphens

***

Asterisks
___

Underscores

Line Breaks My basic recommendation for learning how line breaks work is to experiment and discover – hit once (i.e., insert one newline), then hit it twice (i.e., insert two newlines), see what happens. You'll soon learn to get what you want. "Markdown Toggle" is your friend.

Here are some things to try out:

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a *separate paragraph*.

This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the *same paragraph*.