Markdown is a wonderfully simple approach to creating web pages, writtenby John Gruber of DaringFireball. You get on with the business of writing (without any fancycode) and Markdown takes care of producing clean, web standardscompliant HTML.

The Daring Fireball site provides full documentation forMarkdown, but the following examplesshould get you started.

Roam markdown uses double-caret: ^^highlight^^. Andrew Shell's answer mentions double-equals. The accepted and clearly correct answer is mark from Matthias above, but I thought I had seen carets in some other flavor of markdown.

Section Headings

1. You can use the custom no-loc Markdown extension to identify strings of content that you would like the localization process to ignore. All strings called out will be case-sensitive; that is, the string must match exactly to be ignored for localization. To mark an individual string as non-localizable, use this syntax::::no-loc text='String'::.
2. The Markdown Guide is a free and open-source reference guide that explains how to use Markdown, the simple and easy-to-use markup language you can use to format virtually any document. Get Started DigitalOcean App Platform, a new PaaS that gets your apps.

You can define headings of different levels when creating a web page.The most important heading (which typically only occurs once on eachpage -- at the top) is heading 1. A level 1 heading can be created withMarkdown by typing a single '#' character at the start of a line. Theheading at the top of this page was defined like this:

To create a secondary heading (such as the one for this section) youjust use two '#' characters, like so:

You can use up to six '#' characters to create a level 6 heading, butyou will probably find that you don't need to nest your headings quiteso deeply!

Paragraphs

Paragraphs are very easy; separate them with a blank line. You can writeyour paragraph on one long line, or you can wrap the lines yourself ifyou prefer.

This section was marked up like so:

Bold and Italics

It's very easy to add emphasis with bold and italics:

You can also use underscores if you prefer:

Links

Create simple links by wrapping square brackets around the link text andround brackets around the URL:

If you want to give your readers an extra about the link that they'reabout to follow you can set a link title:

Titles usually appear as a tooltip when you hover over the link, andhelp search engines work out what a page is about.

Bulleted Lists

Start each line with hyphen or an asterisk, followed by a space. Listitems can be nested. This text:

...produces this list:

• Bullet 1
• Bullet 2
  • Bullet 2a
  • Bullet 2b
• Bullet 3

Numbered Lists

Start each line with number and a period, then a space. This text…

...produces this list:

1. Baked potato
2. Baked beans
3. Pepper

Quotes

If you need to cite a paragraph of somebody else's work you really oughtto attribute it to them properly by using HTML's <blockquote/> tag.You can produce it with Markdown by adding a single '>' character atthe beginning of the line.

This text:

...produces:

One thing was certain, that the white kitten had had nothingto do with it -- it was the black kitten's fault entirely. Forthe white kitten had been having its face washed by the old cat,for the last quarter of an hour (and bearing it pretty well,considering) so you see that it couldn't have had any hand inthe mischief. -- Lewis Carroll, Through the LookingGlass

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.

Markdown Markup Language

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

Markdown Markup

See Full List On Commonmark.org

GitHub supports emoji!

Markdown Mark Tag

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

Markdown References Link

Last updated Jan 15, 2014