Skip to content

Instantly share code, notes, and snippets.

@Yojih
Last active July 17, 2018 20:17
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 Yojih/1e61cec34f0274124a66e00654341d0f to your computer and use it in GitHub Desktop.
Save Yojih/1e61cec34f0274124a66e00654341d0f to your computer and use it in GitHub Desktop.
[Markdown Cheatsheet] #cheatsheet

Introducing Markdown

Markdown is a plain text formatting syntax designed to be converted to HTML. Markdown is popularly used as format for readme files, ... or in text editors for the quick creation of rich text documents. - Wikipedia

As showed in this manual, it uses hash(#) to identify headings, emphasizes some text to be bold or italic. You can insert a link.

Planet

  • Earth
  • Mars

Math

$\sqrt{3x-1}+(1+x)^2$

Code block

@requires_authorization
def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None
class SomeClass:
    pass
>>> message = '''interpreter
... prompt'''

Table

Item Value Qty
Computer 1600 USD 5
Phone 12 USD 12
Pipe 1 USD 234
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment