This is Markdown Cheatsheet Demo. This page is hosted by GitHub and is using it’s default markdown and code highlighter.Please check the raw content of this file for the markdown usage.

1. Github Markdown Cheat Sheet Emoji
2. Github Markdown Cheat Sheet Color

1. Markdown checkbox in github. Github markdown coded in README.md or any file with md extension. Add hyphen starting of the line with or x, space should be added before and after square brackets followed by content. This is also called Task list.
2. Dunwu.github.io 个人文档整理项目. Markdown Cheat Sheet. 在 Markdown 中，粗体文本、斜体文本可以使用. 或.
3. This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can.put.Markdown. into a blockquote. Horizontal Rule- Hyphens. Asterisks Underscores see more: Markdown Cheatsheet.

The idea for Markdown is to make it easy to read, write, and edit prose. HTML is a.publishing. format; Markdown is a.writing. format. Thus, Markdown's formatting syntax only addresses issues that can be conveyed in plain text. For any markup that is not covered by Markdown's syntax, you simply use HTML itself.

Typography Elements in One

Let’s start with a informative paragraph. This text is bolded. But not this one! How about italic text? Cool right? Ok, let’s combine them together. Yeah, that’s right! I have code to highlight, so ThisIsMyCode(). What a nice! Good people will hyperlink away, so here we go or http://www.example.com.

Headings H1 to H6

H2 Heading

H3 Heading

H4 Heading

H5 Heading

H6 Heading

Footnote

Let’s say you have text that you want to refer with a footnote, you can do that too! This is an example for the footnote number one ¹. You can even add more footnotes, with link! ²

LateX:

This is an online latex: ( pi = 4 sum_{i=0}^{infty} frac{(-1)^{i}}{2i+1} ;;; & ;;; G_{munu} = 8pi T_{munu} )

This is an equation:

Blockquote

Start by doing what’s necessary; then do what’s possible; and suddenly you are doing the impossible. –Francis of Assisi

NOTE: This theme does NOT support nested blockquotes.

Awesome font icons:

Here are some icon’s from font awesome. They are pretty awesome!

List Items

1. First order list item
2. Second item

• Unordered list can use asterisks
• Or minuses
• Or pluses

Code Blocks

Another way of highlighting

With no language:

And finally directly including and highlighting a source code from source file:

Table

Table 1: With Alignment

Table 2: With Typography Elements

Horizontal Line

The HTML <hr> element is for creating a “thematic break” between paragraph-level elements. In markdown, you can create a <hr> with any of the following:

• ___: three consecutive underscores
• ---: three consecutive dashes
• ***: three consecutive asterisks

renders to:

Media

YouTube Embedded Iframe

Image

1. Footnote number one yeah baby! ↩

2. A footnote you can link to - click here!↩

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

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

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!

Github Markdown Cheat Sheet Emoji

To see a list of every image we support, check out the Emoji Cheat Sheet.

Github Markdown Cheat Sheet Color

Last updated Jan 15, 2014