markdown语法指南

原文：https://guides.github.com/features/mastering-markdown/

语法指南

这里有 markdown 语法的概述，您可以使用GitHub.com或您自己的文本文件中的任何地方。

头

# This is an <h1> tag## This is an <h2> tag###### This is an <h6> tag

重点

*This text will be italic*_This will also be italic_**This text will be bold**__This will also be bold__*You **can** combine them*

This text will be italic
This will also be italic

This text will be bold
This will also be bold

You can combine them

列表
无序

* Item 1* Item 2  * Item 2a  * Item 2b

有序

1. Item 12. Item 23. Item 3   * Item 3a   * Item 3b

图片

![GitHub Logo](/images/logo.png)Format: ![Alt Text](url)

链接

http://github.com - automatic![GitHub](http://github.com)

引用文字

As Kanye West said:> We're living the future so> the present is our past.

内嵌代码

I think you should use an`<addr>` element here instead.

GitHub Flavored Markdown

GitHub.com使用其自己markdown语法的版本，提供了一套附加的实用功能，其中有许多更容易与GitHub.com的内容工作。

请注意，GitHub Flavored Markdown的一些特点只适用于描述和问题的意见和Pull请求。这些措施包括@mentions以及引用SHA-1哈希值，issues和pull requests。任务列表也是可用的在Gist comments和 in Gist Markdown 文件中。

语法高亮

下面是如何使用的语法高亮与GitHub Flavored Markdown的例子：

function fancyAlert(arg) {  if(arg) {    $.facebox({div:'#foo'})  }}

你也可以简单地缩进代码由四个空格：
function fancyAlert(arg) {
if(arg) {
$.facebox({div:’#foo’})
}
}
下面是Python代码没有语法高亮的例子：
def foo():
if not bar:
return True

任务列表

- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported- [x] list syntax required (any unordered or ordered list supported)- [x] this is a complete item- [ ] this is an incomplete item

• [x] @mentions, #refs, links, formatting, and tags supported
• [x] list syntax required (any unordered or ordered list supported)
• [x] this is a complete item
• [ ] this is an incomplete item

表

你可以通过组装一个单词列表，并将它们分割带连字符 - 来创建表（对第一行），然后将每个列用管分离|：

First Header | Second Header------------ | -------------Content from cell 1 | Content from cell 2Content in the first column | Content in the second column

将成为：

First Header Second Header Content from cell 1 Content from cell 2 Content in the first column Content in the second column

SHA参考
任何对于提交的SHA-1哈希值将会自动转换成一个链接提交到GitHub上。

16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac

一个存储库中的问题参考

任何数字与issue或pull request 将被自动转换成一个链接。

#1mojombo#1mojombo/github-flavored-markdown#1

用户名@mentions

键入一个@符号，后跟一个用户名，将通知该人前来查看注释。这就是所谓的“@mention”，因为你提到某个人。您也可以@mention 团队在一个组织内部。

自动链接网址

任何URL（如http://www.github.com/）将被自动转换成可点击的链接。

删除线

任何词语被包裹，用两个代字符（如这个）将出现划掉。

表情符号

GitHub supports emoji! :sparkles: :camel: :boom:

要查看每一个我们支持图像的名单，检出样式表情。
check out

相关文章：
GitHub Flavored Markdown

MarkDown