Skip to content

Instantly share code, notes, and snippets.

@sethbergman
Created October 21, 2015 02:55
Show Gist options
  • Save sethbergman/eba62d45c82d0767a5a0 to your computer and use it in GitHub Desktop.
Save sethbergman/eba62d45c82d0767a5a0 to your computer and use it in GitHub Desktop.
markdown.md

Markdown

Quick reference to markdown syntax.

Table of Contents

Wikipedia-like Citations
Example Table of Contents
Phrase Emphasis
Links
Images
Lists
Bock Quotes
Code Spans
Horizontal Lines
Manual Line Breaks
Markdown Comments
Task Lists
Resources
Tools
Libraries
Todos

Wikipedia-like Citations

This is some text where "I'm quoting this part"<sub><sup>[[111]][c]</sub></sup> because it needs cited.

Citations
---------
1. [**^**](#wikipedia-like-citations) [Author, Title, Etc.](http://google.com)

[c]: #citations

This is some text where "I'm quoting this part"[111] because it needs cited.

Citations

  1. ^ Author, Title, Etc.

Small Text

The small text looks <sub><sup>really really really<sub><sup>small.

The small text looks really really reallysmall.

Example Table of Contents

Example Table of Contents
--------------------

**[Section A](#section-a)**           <- MAKE SURE YOU HAVE 2 SPACES AFTER EACH LINE
**[Section B](#section-b)**   
**[Section C](#section-c)**   

Section A
---------
<!-- Content A -->
Section B
---------
<!-- Content B -->
Section C
---------
<!-- Content C -->

Edit this doc to see how I did the table of contents here.

Phrase Emphasis

*italic*   **bold**
_italic_   __bold__

italic bold
italic bold

Links

[example](http://url.com/ "Title")

OR

An [example][id]. Then, anywhere
else in the doc, define the link:

  [id]: http://example.com/  "Title"

example

OR

An example. Then, anywhere else in the doc, define the link:

Images

![alt text](/path/img.jpg "Title")

OR

![alt text][id]

[id]: /url/to/img.jpg "Title"

alt text

OR

alt text

Lists

Ordered, without paragraphs:

1.  Foo
2.  Bar

Unordered, with paragraphs:

*   A list item.

    With multiple paragraphs.

*   Bar

You can nest them:

*   Abacus
    * answer
*   Bubbles
    1.  bunk
    2.  bupkis
        * BELITTLER
    3. burper
*   Cunning
  1. Foo
  2. Bar

Unordered, with paragraphs:

  • A list item.

    With multiple paragraphs.

  • Bar

You can nest them:

  • Abacus
    • answer
  • Bubbles
    1. bunk
    2. bupkis
      • BELITTLER
    3. burper
  • Cunning

Block Quotes

> Email-style angle brackets
> are used for blockquotes.

> > And, they can be nested.

> #### Headers in blockquotes
> 
> * You can quote a list.
> * Etc.

Email-style angle brackets are used for blockquotes.

And, they can be nested.

Headers in blockquotes

  • You can quote a list.
  • Etc.

Code Spans

    `<code>` spans are delimited
    by backticks.

    ```javascript
    var listener = node.addEventListener("click", (event) => {
        let _target = event.target;
        this.handleClick(_target);
    });
    ```
    This is a normal paragraph.
    
        This is a preformatted
        code block.

<code> spans are delimited by backticks.

var listener = node.addEventListener("click", (event) => {
    let _target = event.target;
    this.handleClick(_target);
});

This is a normal paragraph.

This is a preformatted
code block.

Horizontal Lines

---

* * *

- - - - 



Manual Line Breaks

At the end of this line there are 2 spaces.  
This sentence has no spaces after it.
See how this sentence wraps the one above?

At the end of this line there are 2 spaces.
This sentence has no spaces after it. See how this sentence wraps the one above?

Markdown Comments

<!-- Markdown comments are the same as html comments. -->

Task Lists

- [x] This is a complete item
- [ ] This is an incomplete item
  • This is a complete item
  • This is an incomplete item

Resources

Tools

Libraries

Todos

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