Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.

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

Markdown is a convenient HTML-focused shorthand syntax for formatting content such as documentation and blog articles, but it lacks basic features for image formatting, such as alignment and sizing. Create a markdown based documentation sites with VuePress.

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 # or *.

You can use Markdown most places around GitHub:

• Comments in Issues and Pull Requests
• Files with the .md or .markdown extension

For more information, see “Writing on GitHub” in the GitHub Help.

Examples

Syntax guide

Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.

Headers

Emphasis

Lists

Unordered

Ordered

Html Inside Markdown

Images

Links

Blockquotes

Inline code

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.

Syntax highlighting

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:

Task Lists

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!

Tables

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 |:

Would become:

SHA references

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.

Username @mentions

Typing an @ 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.

Strikethrough

Any word wrapped with two tildes (like ~~this~~) will appear crossed out.

Emoji

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 with plain'ol HTML knowledge! Boom!

Using Html In Markdown

Installs

• Total9K
• Win4K
• Mac3K
• Linux2K

Readme

Source

raw.​githubusercontent.​com

Helpful Sublime Text snippets to get you started with GitHub flavored Markdown by letting you type the plain old HTML tags.

Installation

Via Package Control

The easiest way is to install it via Package Control.

• Go to Command PaletteCtrl + Shift + P or ⌘ + Shift + P
• Select Package Control : Install Package
• Search for Github Markdown Snippets

Manual

• Clone the repository or download the ZIP
• Extract the archive
• Put it in your Packages( Preferences > Browse Packages... ) directory.
  

Using with Emmet

If you have Emmet installed, tab triggers may not function as expected due to this.

To get around the problem, go to

and add the following in your settings file.

This should let markdown snippets take precedence over emmet's tab to expand abbreviations feature and provide correct snippets.

Note that any tab trigger not set by this plugin will be converted to HTML tags which is convenient for peoplewho want to use HTML tags inside Markdown files.

Usage

A consolidated guide is available here.

Type a tag name and hit tab. That's it! :relaxed:

:snowflake: Long tags like blockquote are shortened for power use.

List of Tab Triggers

Using Html Inside Markdown

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

Bold Text

Italic Text

Put a nice, beautifulquote here…

Markdown To Html Online

Strike Through

Inline Code Snippet

1. First Item
2. Second Item
3. Third Item

• I
• Love
• Markdown