Skip to content

Instantly share code, notes, and snippets.

@maczniak
Last active April 2, 2016 04:22
Show Gist options
  • Save maczniak/f1e36861c69b0654903a to your computer and use it in GitHub Desktop.
Save maczniak/f1e36861c69b0654903a to your computer and use it in GitHub Desktop.
Markdown Syntax

used in Gist, comments, issues, pull requests and .md and .markdown extension files.

standard Markdown (SM)

  • paragraphs are separated by one or more blank lines
  • heading from # to ######
  • blockquote >
  • bold <strong> ** or __
  • italic <em> * or _
  • unordered list * or -
  • ordered list 1., 2., 3., ...
  • nested list by two spaces indentation
  • inline code ` (no special formatting applied)
  • pre-formatted code block with leading four spaces (eight spaces in lists)
  • link [text](url)
  • image ![alt](url)

GitHub Flavored Markdown (GFM)

  • ignore underscores in words do_this_and_do_that_and_another_thing
  • URL autolink
  • strikethrough ~~Mistaken text.~~
  • fenced code block ``` without leading four spaces
  • syntax highlight ```ruby
  • table with optional leading and trailing pipe
Left-Aligned  | Center Aligned  | Right Aligned
:------------ |:---------------:| -----:
col 3 is      | some wordy text | $1600
  • HTML allowed elements and attributes
  • newline in comments as real line breaks
  • task lists [ ] and [x] in lists
  • reference to commits and issues
    • SHA: a5c3785ed8d6a35868bc169f07e40e889087fd2e
    • User@SHA: jlord@a5c3785ed8d6a35868bc169f07e40e889087fd2e
    • User/Repository@SHA: jlord/sheetsee.js@a5c3785ed8d6a35868bc169f07e40e889087fd2e
    • #Num: #26
    • GH-Num: GH-26
    • User#Num: jlord#26
    • User/Repository#Num: jlord/sheetsee.js#26
  • emoji
  • Keyboard shortcuts: reply with qoute r, @mention, :emoji, #issue
  • fullscreen (Zen Mode)
  • cons - no automatic toc, no color styling, no headless table

Reference

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