Mar 16, 2015 Markdown is a plain text formatting syntax for writers. It allows you to quickly write structured content for the web, and have it seamlessly converted to clean, structured HTML. It allows you to quickly write structured content for the web, and have it seamlessly converted to clean, structured HTML. 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.
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
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.
What is the regular oxygen levels. How do Oxygen levels and my lung function work. My lung function is 38%, but my oxygen levels stay on the 90's. With any exertion my body becomes. What are normal readings? A normal level of oxygen is usually 95% or higher. Some people with chronic lung disease or sleep apnea may have normal levels around 90%. The “SpO2” reading on a pulse oximeter shows the percentage of oxygen in someone’s blood. If your home SpO2 reading is lower than 95%, call your health care provider.
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!
Markdown Http Url
To see a list of every image we support, check out the Emoji Cheat Sheet.
Last updated Jan 15, 2014