flâneur

GitHub Flavored Markdown Spec

github.github.com · 25,933 words · saved by 1 readers

GitHub Flavored Markdown, often shortened as GFM, is the dialect of Markdown that is currently supported for user content on GitHub.com and GitHub Enterprise. This formal specification, based on the CommonMark Spec, defines the syntax and semantics of this dialect. GFM is a strict superset of CommonMark. All the features which are supported in GitHub user content and that are not specified on the original CommonMark Spec are hence known as extensions, and highlighted as such. While GFM supports a wide range of inputs, it’s worth noting that GitHub.com and GitHub Enterprise perform additional post-processing and sanitization after GFM is converted to HTML to ensure security and consistency of the website. Markdown is a plain text format for writing structured documents, based on conventions for indicating formatting in email and usenet posts. It was developed by John Gruber (with help from Aaron Swartz) and released in 2004 in the form of a syntax description and a Perl script (Markdown

GitHub Flavored Markdown Spec GitHub Flavored Markdown Spec Version 0.29-gfm (2019-04-06) This formal specification is based on the CommonMark Spec by John MacFarlane and licensed under 1 Introduction 1.1 What is GitHub Flavored Markdown? 1.2 What is Markdown? 1.3 Why is a spec needed? 1.4 About this document 2 Preliminaries 2.1 Characters and lines 2.2 Tabs 2.3 Insecure characters 3 Blocks and inlines 3.1 Precedence 3.2 Container blocks and leaf blocks 4 Leaf blocks 4.1 Thematic breaks 4.2 ATX headings 4.3 Setext headings 4.4 Indented code blocks 4.5 Fenced code blocks 4.6 HTML blocks 4.7 Lin

related reading