This syntax is a little 'hack' to do the same thing instead of the markdown notations. Because there is no universal notation for markdown text, the notations may be different for each platform. Here is an overview for several platforms: On Slack, you must use a single tilde; On GitHub, you can use all notations. GitHub Pages is a service that turns Markdown files into a website and hosts them for free on the internet. If you know how to use GitHub and you need to create a simple webpage, you can’t do better than GitHub Pages. Just create a new repository on GitHub, commit the Markdown files, and enable the GitHub Pages feature. 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.

Share samples of code with fenced code blocks and enabling syntax highlighting.

In this article

Fenced code blocks

You can create fenced code blocks by placing triple backticks ``` before and after the code block. We recommend placing a blank line before and after code blocks to make the raw formatting easier to read.

Tip: To preserve your formatting within a list, make sure to indent non-fenced code blocks by eight spaces.

Syntax highlighting

You can add an optional language identifier to enable syntax highlighting in your fenced code block.

For example, to syntax highlight Ruby code:

We use Linguist to perform language detection and to select third-party grammars for syntax highlighting. You can find out which keywords are valid in the languages YAML file.

Further reading

• 'Basic writing and formatting syntax'

In this article

Parameters

Github Markdown Api Documentation

Name	Type	In	Description
accept	string	header	Setting to application/vnd.github.v3+json is recommended.
text	string	body	Required. The Markdown text to render in HTML.
mode	string	body	The rendering mode. Default: markdown
context	string	body	The repository context to use when creating references in gfm mode.

Code samples

Shell

JavaScript (@octokit/core.js)

Response

Github Readme Markup Cheat Sheet

Not modified

Notes

Github Markdown Api

Render a Markdown document in raw mode

You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.