Skip to content

Instantly share code, notes, and snippets.

@gkhays
Last active February 3, 2017 21:56
Show Gist options
  • Save gkhays/1fd7b7c491ff1a90eda0 to your computer and use it in GitHub Desktop.
Save gkhays/1fd7b7c491ff1a90eda0 to your computer and use it in GitHub Desktop.

Markdown Quick Start

This is my attempt to capture some of the things I (relatively) frequently do in Markdown. It is by no means definitive, but I always seem to forget these ones.

Links

Inline-style links use parentheses immediately after the link text. For example:

This is an [example link](http://example.com/).

Output: This is an example link.

Optionally, you may include a title attribute in the parentheses:

This is an [example link](http://example.com/ "With a Title").

Output: This is an example link.

Reference Links

You can do reference links too!

[Markdown Syntax Guide on SourceForge] [1]

    [1]: https://sourceforge.net/p/slack/wiki/markdown_syntax/

Output: [Markdown Syntax Guide on SourceForge] 1

###Images This is image syntax, note the leading "bang"

![Portecle](images/Portecle1.7.png?raw=true "Portecle 1.7")

###Block Quotes

Block quotes are designated with a right-facing chevron or greater-than symbol, e.g. '>'.

> This paragraph is shown as
> a block quote. Notice the
> quick brown fox...

This paragraph is shown as
a block quote. Notice the
quick brown fox...

Slack uses a triple chevron to block quote multiple lines.

>>> Slack style block quotes
supported here or no?

Slack style block quotes
supported here or no?

No, I guess not.

####Backslash Escapes

Show me the asterisks!

\* show them \*

Becomes... * show them *

Some others...

\ backslash
` backtick
* asterisk
{} curly braces
[] square braces

Language Support

```bash

The ones I commonly use:

  • bash
  • bat
  • java
  • python

See Linguist-Languages.

#####Miscellaneous

Show array syntax inline to text: a[0] See? 😄 🤘
As you can see above, emoji too!

:smile: :metal:

##References https://daringfireball.net/projects/markdown/basics
https://daringfireball.net/projects/markdown/syntax#link
http://www.arlocarreon.com/blog/github/pre-and-code-tags-in-github-markdown/ (pre-tags for code blocks)
https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
https://enterprise.github.com/downloads/en/markdown-cheatsheet.pdf
http://www.emoji-cheat-sheet.com/
https://help.github.com/articles/basic-writing-and-formatting-syntax/
https://sourceforge.net/p/gogs/wiki/markdown_syntax/
https://docs.gitlab.com/ee/user/markdown.html

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