Markdown Cheatsheet
Kudos to adam-p
Open source no copy rights.
Feel free to share, here you can visit the git hub repository
and here you can check the License: CC-BY
This is intended as a quick reference and showcase. For more complete info, see John Gruber's original spec and the Github-flavored Markdown info page.
Note that there is also a Cheatsheet specific to Markdown Here if that's what you're looking for. You can also check out more Markdown tools.
Table of Contents
- Headers
- Emphasis
- Lists
- Links
- Images
- Code and Syntax Highlighting
- Tables
- Blockquotes
- Horizontal Rule
- Youtube videos
Headers
H1
H2
H3
H4
H5
H6
Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
Alt-H2
H1
H2
H3
H4
H5
H6
Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
Alt-H2
Emphasis
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.~~
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.
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 behaviour, where trailing spaces are not required.)
* Unordered list can use asterisks
- Or minuses
+ Or pluses
First ordered list item
Another item
Unordered sub-list.
Actual numbers don't matter, just that it's a number
Ordered sub-list
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 behaviour, where trailing spaces are not required.)
Unordered list can use asterisks
Or minuses
Or pluses
Links
There are two ways to create links.
[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].
URLs and URLs in angle brackets will automatically get turned into links.
http://www.example.com or <http://www.example.com> and sometimes
example.com (but not on Github, for example).
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
I'm an inline-style link with title
I'm a relative reference to a repository file
You can use numbers for reference-style link definitions
Or leave it empty and use the link text itself.
URLs and URLs in angle brackets will automatically get turned into links.
http://www.example.com and sometimes
example.com (but not on Github, for example).
http://www.example.com or
Some text to show that the reference links can follow later.
Images
Here's our logo (hover to see the title text):
Inline-style:
Reference-style:
Here's our logo (hover to see the title text):
Inline-style: alt text
Reference-style: alt text
Code and Syntax Highlighting
Code blocks are part of the Markdown spec, but syntax highlighting isn't. However, many renderers -- like Github's and Markdown Here -- support syntax highlighting. Which languages are supported and how those language names should be written will vary from renderer to renderer. Markdown Here supports highlighting for dozens of languages (and not-really-languages, like diffs and HTTP headers); to see the complete list, and how to write the language names, see the highlight.js demo page.
Inline `code` has `back-ticks around` it.
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.
var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print s
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
var s = "JavaScript syntax highlighting";
alert(s);
s = "Python syntax highlighting"
print s
No language indicated, so no syntax highlighting in Markdown Here (varies on Github).
But let's throw in a tag.
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 |
There must be at least 3 dashes separating each header cell.
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 |
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
There must be at least 3 dashes separating each header cell. 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.
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.
Hyphens
Asterisks
Underscores
Three or more...
Hyphens
Asterisks
Underscores
Youtube videos
They can't be added directly but you can add an image with a link to the video like this:
<a href="https://i.ytimg.com/vi/_4xMnmQlp6M/hqdefault.jpg?custom=true&w=336&h=188&stc=true&jpg444=true&jpgq=90&sp=68&sigh=IDNbbxqarp6EfCW5X74BbzFwSJE
" target="_blank"><img src="https://i.ytimg.com/vi/_4xMnmQlp6M/hqdefault.jpg?custom=true&w=336&h=188&stc=true&jpg444=true&jpgq=90&sp=68&sigh=IDNbbxqarp6EfCW5X74BbzFwSJE"
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](https://i.ytimg.com/vi/_4xMnmQlp6M/hqdefault.jpg?custom=true&w=336&h=188&stc=true&jpg444=true&jpgq=90&sp=68&sigh=IDNbbxqarp6EfCW5X74BbzFwSJE)](https://www.youtube.com/watch?v=_4xMnmQlp6M)
Or, in pure Markdown, but losing the image sizing and border:
Referencing a bug by #bugID in your git commit links it to the slip. For example #1.
Hi! I am a content-detection robot. This post is to help manual curators; I have NOT flagged you.
Here is similar content:
https://trello.com/c/y51WiCh3/256-copy-me-markdown-cheatsheet
How get more readers for Your old steemit posts? Boost 🚀🚀your views
Add recommended posts to the bottom of your steemit post . follow my blog to learn how it works . Let your Followers See All your steemit posts in each one post
It is open source at the git hub repository, it is free to copy paste and share with everyone.I made the appropriate changes so the post can appear properly on steemit.
Everything here goes by open domain standards.
There is nothing offensive. just sharing open source info like everyone else.
Thanks.
This is what I needed...... I've been having problems transferring my blog over.
btw the bots link sucks it froze my laptop.. i flagged it.. flag the bot guys its glitched out..
Then why isnt there a page like this somewhere that is easy to find. my eyes hurt..
Exactly, their blog formatting page is basic bitch mode.
I can see no difference in the video links at the end...? there is no border and the sizes are the same...?
Thank you, this is very helpful!
looking everywhere for this..
Hello. I have a question regarding a link into an ordered list.
The does not work. Look:
How can you solve this problem?
Do you really think I am going to click on those scammy links huh? You deserve a 100% downvote. I hope you will enjoy it.
Those are indeed legit links. I did that example just to show that the link property doesn't work when the elements are put in the list mode!
That could be usefull for other people as well if they wanna insert links into lists.
ok I will remove this flag then but so you know this is an outdated guide almost 1 year ago. things have changed about steemit posts. you need to check them out.
well, this article was showing things 'close' to what I needed. Even if it's outdated, he might have found (what I needed) in the meanwhile and could have helped me. But it seems that the pursuit has to continue.
Now we are good
Did you find what you needed?