Created
June 2, 2014 06:49
-
-
Save yashprit/823af6de9cefc38c1cf2 to your computer and use it in GitHub Desktop.
List of GitHub Mark Down syntax
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#Heading | |
~~~ | |
# H1 | |
## H2 | |
### H3 | |
#### H4 | |
##### H5 | |
###### H6 | |
or | |
Alt-H1 | |
====== | |
Alt-H2 | |
------ | |
~~~ | |
#Word | |
~~~ | |
Emphasis, aka italics, with *asterisks* or _underscores_. | |
Strong emphasis, aka bold, with **asterisks** or __underscores__. | |
Combined emphasis with **asterisks and _underscores_**. | |
Strikethrough uses two tildes. ~~Scratch this.~~ | |
~~~ | |
#List | |
~~~ | |
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. | |
Some text that should be aligned with the above item. | |
* Unordered list can use asterisks | |
- Or minuses | |
+ Or pluses | |
~~~ | |
#Link | |
~~~ | |
[I'm an inline-style link](https://www.google.com) | |
[I'm a reference-style link][Arbitrary case-insensitive reference text] | |
[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. | |
~~~ | |
#Images | |
~~~ | |
Here's our logo (hover to see the title text): | |
Inline-style: | |
![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 1") | |
Reference-style: | |
![alt text][logo] | |
~~~ | |
#Code and Syntax Highlighting | |
~~~ | |
Inline `code` has `back-ticks around` it. | |
Blocks of code are either fenced by lines with three back-ticks ```, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting. | |
```javascript | |
var s = "JavaScript syntax highlighting"; | |
alert(s); | |
``` | |
```python | |
s = "Python syntax highlighting" | |
print s | |
``` | |
``` | |
No language indicated, so no syntax highlighting. | |
But let's throw in a <b>tag</b>. | |
``` | |
~~~ | |
#Tables | |
~~~ | |
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. | |
Blockquotes are very handy in email to emulate reply text. This line is part of the same quote. | |
Quote break. | |
~~~ | |
#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 <em>tags</em>.</dd> | |
</dl> | |
~~~ | |
#Horizontal Rule | |
~~~ | |
Three or more... | |
--- | |
Hyphens | |
*** | |
Asterisks | |
___ | |
Underscores | |
Three or more... | |
Hyphens | |
Asterisks | |
Underscores | |
Line Breaks | |
My basic recommendation for learning how line breaks work is to experiment and discover -- hit <Enter> 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*. | |
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 begins a separate paragraph, but... | |
This line is only separated by a single newline, so it's a separate line in the same paragraph. | |
(Technical note: Markdown Here uses GFM line breaks, so there's no need to use MD's two-space line breaks.) | |
~~~ | |
#Youtube videos | |
~~~ | |
They can't be added directly but you can add an image with a link to the video like this: | |
<a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE_VIDEO_ID_HERE | |
" target="_blank"><img src="http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg" | |
alt="IMAGE ALT TEXT HERE" width="240" height="180" border="10" /></a> | |
Or, in pure Markdown, but losing the image sizing and border: | |
[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE) | |
~~~ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Cheatsheet of all simple and frequently used markedown, taken from here
https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet.
Syntax Highlighter http://highlightjs.org/static/test.html
Markdown online editor http://markdown-here.com/livedemo.html
GiHub Help Page: https://help.github.com/articles/github-flavored-markdown
Markdown Project : http://daringfireball.net/projects/markdown/