Skip to content

Instantly share code, notes, and snippets.

@carljdp
Last active January 17, 2019 09:58
Show Gist options
  • Save carljdp/ff6eb2b9bd45ed891a57c84645d93e77 to your computer and use it in GitHub Desktop.
Save carljdp/ff6eb2b9bd45ed891a57c84645d93e77 to your computer and use it in GitHub Desktop.
Github Flavoured Markdown

Github Flavoured Markdown (GFM) Syntax Guide

Tested on Github / MS DevOps Wiki

Other Guides

Emoji

Whitespace

  •    (2 spaces)
  •  

Codeblock with whitespace
<code>&nbsp;&nbsp;</code>   

Indentation (Whitespace)

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indent∙∙
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indent∙∙

      Indent
      Indent

┳ ━ ┓∙∙
┃&nbsp;&nbsp;&nbsp;&nbsp;┗∙∙
┣ ━ ┳∙∙
┃&nbsp;&nbsp;&nbsp;&nbsp;┣∙∙
┃&nbsp;&nbsp;&nbsp;&nbsp;┗∙∙
┗ ━  ┓∙∙
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;┗∙∙

┳ ━ ┓
┃    ┗
┣ ━ ┳
┃    ┣
┃    ┗
┗ ━ ┓
      ┗

Indented Lists

  • Level 1
    • Level 2
      • Level 3
      • Further levels have the same bullet as level 3
    • Level 2
    • Level 2
  • Level 1
  • Level 1

Horizontal Line

Normal
--- or <hr>; Needs to be preceded with an empty line.


Force empty preceding line
<br><hr>


normal text preceding horizonal line is treated as heading (linkable)

Empty Line

<br/> or &nbsp; or &#160;

Symbols

Text Formatting

- number <sub>base</sub>

- number <sup>exp</sup>
  • number base

  • number exp

Escape auto generated links

www<i></i>.google<i></i>.com

www.google.com

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