Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.
This video shows how to change the output format in the YAML header of a R markdown file to create a 'Github-flavored' MD file. This file can be viewed on Gi. CLI tool for converting Markdown files to PDF.
What you will learn:
- How the Markdown format makes styled collaborative editing easy
- How Markdown differs from traditional formatting approaches
- How to use Markdown to format text
- How to leverage GitHub’s automatic Markdown rendering
- How to apply GitHub’s unique Markdown extensions
What is Markdown?
Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like
You can use Markdown most places around GitHub:
- Comments in Issues and Pull Requests
- Files with the
For more information, see “Writing on GitHub” in the GitHub Help.
Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.
GitHub Flavored Markdown
GitHub.com uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com.
Note that some features of GitHub Flavored Markdown are only available in the descriptions and comments of Issues and Pull Requests. These include @mentions as well as references to SHA-1 hashes, Issues, and Pull Requests. Task Lists are also available in Gist comments and in Gist Markdown files.
Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:
You can also simply indent your code by four spaces:
Here’s an example of Python code without syntax highlighting:
If you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list. It also works in Pull Requests!
You can create tables by assembling a list of words and dividing them with hyphens
- (for the first row), and then separating each column with a pipe
|First Header||Second Header|
|Content from cell 1||Content from cell 2|
|Content in the first column||Content in the second column|
Any reference to a commit’s SHA-1 hash will be automatically converted into a link to that commit on GitHub.
Issue references within a repository
Any number that refers to an Issue or Pull Request will be automatically converted into a link.
@ symbol, followed by a username, will notify that person to come and view the comment. This is called an “@mention”, because you’re mentioning the individual. You can also @mention teams within an organization.
Automatic linking for URLs
Any URL (like
http://www.github.com/) will be automatically converted into a clickable link.
Any word wrapped with two tildes (like
~~this~~) will appear crossed out.
GitHub supports emoji!
To see a list of every image we support, check out the Emoji Cheat Sheet.
Last updated Jan 15, 2014
GitHub Flavored Markdown lets you create useful documents in GitHub and GitHub Enterprise using
.md files.Like other varieties of markdown, GitHub Markdown tries to be as readable as possible in its raw form, resulting in an intentionally limited set of formatting options.However, these options can feel restrictive when dealing with complex content.
Although GitHub Markdown strips out most HTML tags, here are a few tricks that can give you more flexibility when formatting your documents.These advanced formatting options can make your documents more useable, but they come at the expense of plain text readability, so use with caution.
Check out this excellent cheatsheet for an overview of standard formatting in GitHub Markdown.
To left align and resize an image:
To right align and resize an image:
To center and resize an image:
To create a dropdown containing text:
ExampleThis is a dropdown with text!
To create a dropdown containing a list:
- This dropdown contains
- a list!
To create a dropdown containing an image:
To create a dropdown containing code:
Github Md File Format
To create a single button:
To create a row of buttons:
|Click here||Or here||Or here|
Github Md Formatting Tools
To link to a heading:
This is an example of an anchor link to a heading.
To create an anchor anywhere on the page, use:
To reference it:
This is an example of an anchor link anywhere on the page.
To create a horizontal line:
To add extra space, use one or more:
GitHub Flavored Markdown Spec - https://github.github.com/gfm/
Advanced Markdown with David Wells - https://github.com/DavidWells/advanced-markdown
Markdown Cheatsheet PDF - https://enterprise.github.com/downloads/en/markdown-cheatsheet.pdf