Skip to content

Instantly share code, notes, and snippets.

@edwardbeckett
Last active March 18, 2019 20:36
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save edwardbeckett/4340601 to your computer and use it in GitHub Desktop.
Save edwardbeckett/4340601 to your computer and use it in GitHub Desktop.
Markdown Reference Guide
## Headers ##
(Hashes on right are optional)
# Header 1 #
## Header 2 ##
### Header 3 ###
#### Header 4 ####
##### Header 5 #####
## Markdown plus h2 with a custom ID ## {#id-goes-here}
[Link back to H2](#id-goes-here)
This is a paragraph, which is text surrounded by whitespace. Paragraphs can be on one
line (or many), and can drone on for hours.
Here is a Markdown link to [Warped](http://warpedvisions.org), and a literal .
Now some SimpleLinks, like one to [google] (automagically links to are-you-
feeling-lucky), a [wiki: test] link to a Wikipedia page, and a link to
[foldoc: CPU]s at foldoc.
Now some inline markup like _italics_, **bold**, and `code()`. Note that underscores in
words are ignored in Markdown Extra.
![picture alt](https://via.placeholder.com/350x65.png "Title is optional")
> Blockquotes are like quoted text in email replies
>> And, they can be nested
* Bullet lists are easy too
- Another one
+ Another one
1. A numbered list
2. Which is numbered
3. With periods and a space
And now some code:
// Code is just text indented a bit
which(is_easy) to_remember();
Syntax can be applied like to code too ...
```java
public class Foo{
public static void main( String ... args ) {
System.out.println("Code MD Style");
}
}
```
~~~
// Markdown extra adds un-indented code blocks too
if (this_is_more_code == true && !indented) {
// tild wrapped code blocks, also not indented
}
~~~
Text with
two trailing spaces
(on the right)
can be used
for things like poems
### Horizontal rules
* * * *
****
--------------------------
<div class="custom-class" markdown="1">
This is a div wrapping some Markdown plus. Without the DIV attribute, it ignores the
block.
</div>
## Markdown plus tables ##
| Header | Header | Right |
| ------ | ------ | -----: |
| Cell | Cell | $10 |
| Cell | Cell | $20 |
* Outer pipes on tables are optional
* Colon used for alignment (right versus left)
## Markdown plus definition lists ##
Bottled water
: $ 1.25
: $ 1.55 (Large)
Milk
Pop
: $ 1.75
* Multiple definitions and terms are possible
* Definitions can include multiple paragraphs too
## Abbreviations ##
*[ABBR]: Markdown plus abbreviations (produces an <abbr> tag) (Not Supported in GitHub)

Headers

(Hashes on right are optional)

Header 1

Header 2

Header 3

Header 4

Header 5

Markdown plus h2 with a custom ID ## {#id-goes-here}

Link back to H2

This is a paragraph, which is text surrounded by whitespace. Paragraphs can be on one line (or many), and can drone on for hours.

Here is a Markdown link to Warped, and a literal . Now some SimpleLinks, like one to [google] (automagically links to are-you- feeling-lucky), a [wiki: test] link to a Wikipedia page, and a link to [foldoc: CPU]s at foldoc.

Now some inline markup like italics, bold, and code(). Note that underscores in words are ignored in Markdown Extra.

picture alt

Blockquotes are like quoted text in email replies

And, they can be nested

  • Bullet lists are easy too
  • Another one
  • Another one
  1. A numbered list
  2. Which is numbered
  3. With periods and a space

And now some code:

// Code is just text indented a bit
which(is_easy) to_remember();    

Syntax can be applied like to code too ...

public class Foo{
    public static void main( String ... args ) {
        System.out.println("Code MD Style");
    }
}

// Markdown extra adds un-indented code blocks too

if (this_is_more_code == true && !indented) {
    // tild wrapped code blocks, also not indented
}

Text with
two trailing spaces
(on the right)
can be used
for things like poems

Horizontal rules




This is a div wrapping some Markdown plus. Without the DIV attribute, it ignores the block.

Markdown plus tables

Header Header Right
Cell Cell $10
Cell Cell $20
  • Outer pipes on tables are optional
  • Colon used for alignment (right versus left)

Markdown plus definition lists

Bottled water : $ 1.25 : $ 1.55 (Large)

Milk Pop : $ 1.75

  • Multiple definitions and terms are possible
  • Definitions can include multiple paragraphs too

Abbreviations

*[ABBR]: Markdown plus abbreviations (produces an tag) (Not Supported in GitHub)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment