Skip to content

GitHub Markdown

Welcome to the GitHub Markdown site!

The purpose of this page is to list all features regarding the usage of Markdown in GitHub.
From basic formatting such as bold and italic to special ones that are part of GitHub Flavourited Markdown (GFM) does this page cover pretty much everything.

Usage of Markdown

Markdown can be used on various pages of GitHub.

  • From your normal Markdown files (.md) in a GitHub Repository
  • ...to Pages on a Repository's Wiki
  • ...to even Issues and Pull requests can you use it on various places.

Pages

Since not all features are used everywhere is the site split up into different categories to cover them as good as possible.

General

Main Markdown formatting that can be used across GitHub.

General

Issues / Pull requests

Unique formatting options that can only be used in Issue and Pull request comments.

Issues / Pull requests

Wiki

Unique formatting options that can only be used in Wikis.

Wiki

Note about this site and styling

This page uses MkDocs together with the PyMdown extensions.
PyMdown extensions provides certain features that help us to emulate some of GitHub's features like task lists. That said is the style often not the same so it may look different to what GitHub offers. If the style or behaviour is different on GitHub will we mention it.