Github Flavoured Markdown

Github-Flavoured-Markdown.md

Github Flavoured Markdown (GFM) Syntax Guide

Tested on Github / MS DevOps Wiki

Other Guides

• Microsoft Markdown
• Github - Writing on GGithub
• Github - Basic writing and formatting syntax
• Github - Mastering Markdown
• Github Flavoured Markdown Spec
• ikatyang/emoji-cheat-sheet
• Relative links in markup files
• Markdown Syntax Guide

Emoji

• https://unicode.org/emoji/charts/full-emoji-list.html
• https://www.emojicopy.com/

Whitespace

•    (2 spaces)
•  

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

Indentation (Whitespace)

      Indent∙∙
      Indent∙∙

      Indent
      Indent

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

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

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   or  

Symbols

• HTML Symbols
• HTML Character Sets
• UTF-8 Miscellaneous Symbols use by &#code;
• UTF-8 Mathematical Operators
• UTF-8 Currency Symbols
• UTF-8 Arrows
• UTF-8 Letterlike Symbols ™
• UTF-8 Box Drawings
• Complete list of HTML5 UTF-8 Character Codes (see table in middle of page at this link)

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