Github Markdown Syntax



This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax. These are the elements outlined in John Gruber’s original design document. These are just the most basic things you can do, and they are all standard Markdown. GitHub Flavoured Markdown is the same with a few extensions. The standard Markdown. Markdown is a standard developed by John Gruber. The main goal with Markdown is to make the file possible to read even in pure text.

SyntaxSyntax

Markdown's syntax is intended for one purpose: to be used as a format for writing for the web. Markdown is not a replacement for HTML, or even close to it. Its syntax is very small, corresponding only to a very small subset of HTML tags. The idea is not to create a syntax that makes it easier to insert HTML tags. Just about everything you’ll need to style in the theme: headings, paragraphs, blockquotes, tables, code blocks, and more.

Last modified by Vincent Massol on 2021/04/20 17:50

Github Markdown Syntax Highlighting Supported Languages

  • Manage
  • Actions
  • Viewers

Select the pages to export:

Legend:
Created Page
Modified Extension Page
Clean Extension Page

Github Markdown Syntax Example

GitHub-Flavored CommonMark Syntax 1.0
TypeJAR
CategorySyntax
Developed by

Vincent Massol, Hassan Ali, XWiki Development Team

Active Installs41
Rating
LicenseGNU Lesser General Public License 2.1
Github Markdown Syntax

Download v8.7.1SourcesIssues

Table of contents

  • Release Notes

Github Markdown Syntax Highlighting Console

This syntax is an extension of the CommonMark Markdown Syntax 1.2 (and thus it inherits from all the XWiki-specific improvements over Common Markdown) and provides a GitHub-Flavored Markdown syntax.

The unique syntax id is: markdown+github/1.0.

8.7

8.6

Introduction

8.5.4

8.5.3

8.5.2

8.5.1

8.5

8.4.3

8.4.2

8.4.1

Github Markdown Syntax

8.4

We recommend using the Extension Manager to install this extension (Make sure that the text 'Installable with the Extension Manager' is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

Dependencies for this extension (org.xwiki.contrib.markdown:syntax-markdown-github10 8.7.1):

  • org.xwiki.contrib.markdown:syntax-markdown-commonmark12 8.7.1
  • org.xwiki.rendering:xwiki-rendering-api 12.10
  • org.xwiki.rendering:xwiki-rendering-syntax-plain 12.10
  • com.vladsch.flexmark:flexmark-ext-gfm-tasklist 0.62.2