The Ultimate Markdown Cheat Sheet

A Programming › Markdown cheat sheet in English by lucbpz

Markdown Cheat Sheet

Markup Editor Markdown Text Md

116,581 views 18,377 downloads 4 Oct 2017 History

PRs

Download

4.6 avg · 2 ratings

HEADERS

Heading Level 1
========
Heading Level 2
-----------

Another way:
# Header1
## Header2
### Header3
...

LINKS & LINK TO A SECTION

Text that will link to a website.
Text that will link to the section.

This will link the text to the "Section With Spaces" header.

You can also organize all your links like this:
[math.stackexchange.com][1]
[link.number.two][2]

[1]: http://math.stackexchange.com/
[2]: http://website.com

IMAGES

![Image of dog] (https://www.codeproject.com/KB/GDI-plus/ImageProcessing2/flip.jpg)

You can insert a table of contents using the marker [TOC]

FOOTNOTES

You can create footnotes like this[^{footnoteName].

[}footnoteName]: Here is the text of the footnote.

Every time you create a footnote it automatically sets the text at the bottom of the page and link them together.

PARAGRAPHS < p >

Paragraphs are lines of text
(single returns are collapsed into a space)

Blank lines indicate a new paragraph

TEXT EFFECTS

bold	bold
italic	italic
~~strikethrough~~	~~strikethrough~~

UNORDERED LIST < ul > < li >

* First bullet

* Second bullet

* * Second.1 bullet

ORDERED LIST < ol > < li >

1. First item

2. Second item

3. Third item

TABLES

| Item | Value | Qty |
| :------- | ----: | :---: |
| Computer | $1600 | 5 |

You can specify alignment with : at one or both sides

FLOWCHARTS

st=>start: Start

e=>end

op1=>operation: My Operation

sub1=>subroutine: My Subroutine

cond=>condition: Yes

or No?:>http://www.google.com

io=>inputoutput: catch something...

st->op1->cond

cond(yes)->io->e

cond(no)->sub1(right)->op1

You can have more info at: http://flowchart.js.org/

CODE

Simple html < code > text: `code`

Code block (< pre >) in a certain language:
``` javascript
if (isBad) {
return false
}
```

HORIZONTAL RULE < hr />

---

- - -

BLOCK QUOTE

> This is a
> blockquote

ADDING ICONS

#### <i class="icon-file"></i> Create a document

This would add the icon before the text

KEYBOARD KEYS

<kbd>Ctrl+Shift+F1</kbd>

DEFINITION LIST

Belongs to this term
: This definition

First, write the syntax for the definition

SEQUENCE DIAGRAMS

Andrew->China: Says Hello

Note right of China: China thinks\nabout it

China-->Andrew: How are you?

Andrew->>China: I am good thanks!

You can have more info at: https://bramp.github.io/js-sequence-diagrams/

Badges

Useful Cheat Sheet Great Cheat Sheet Nice Cheat Sheet Good Cheat Sheet Downloaded from Unusual Locations × 8 🇫🇮 Big in Finland

Comments (1)

rhorber 09:00 31 Oct 2017

From the Markdown Cheat Sheets available, this one suits best for me :).