掌握Markdown

翻译自 https://guides.github.com/features/mastering-markdown/

转载请注明链接

掌握Markdown

Markdown是Github平台上一种轻量且易用，用于设计写作的样式的语法。

我们会学习什么

• Markdown格式如何简化风格化的协作编辑
• Markdown和传统格式有何不同
• 如何使用Markdown格式化文本
• 如何使用Github的Markdown自动渲染
• 如何应用Github独有的Markdown扩展

什么是Markdown？

Markdown是一中在web上设置文本样式的方法。你可以控制文档的显示；使用加粗或者斜体格式化单词，添加图片、创建列表只是我们使用Markdown时可以做的少数几件事情。最主要的是，Markdown只是包含一些非字母字符的普通文本，就像 # 和 *。

你可以在GItHub上的大多数地方使用Markdown：

• Gists （GitHub的一个服务，类似于一个在线的记事本或便利贴，可以用来记录一些代码的小片段或者其他类似的内容）
• 在问题中评论和合并请求（Pull Requests，应该是执行git pull命令的意思，获取并合并其他的库）
• 文件使用.md和.markdown作为扩展名

更多内容，请参阅github帮助中的“Writing on GitHub”

例子

文本——Text

It's very easy to make some words \*\*bold** and other words \*italic* with Markdown. You can even \[link to Google!\]\(http://google.com)

效果如下：

It's very easy to make some words bold and other words italic with Markdown. You can even link to Google!

列表——Lists

Sometimes you want numbered lists:

1. One
2. Two
3. Three

Sometimes you want bullet points:

* Start a line with a star
* Profit!

Alternatively,

- Dashes work just as well
- And if you have sub points, put two spaces before the dash or star:
  - Like this
  - And this

效果如下：

Sometimes you want numbered lists:

1. One
2. Two
3. Three

Sometimes you want bullet points:

• Start a line with a star
• Profit!

Alternatively,

• Dashes work just as well
• And if you have sub points, put two spaces before the dash or star:
  • Like this
  • And this

图片——images

If you want to embed images, this is how you do it:

![Image of Yaktocat](https://octodex.github.com/images/yaktocat.png)

效果如下：

If you want to embed images, this is how you do it:

标题和注释——Headers & Quotes

# Structured documents

Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.

### This is a third-tier heading

You can use one `#` all the way up to `######` six for different heading sizes.

If you'd like to quote someone, use the > character before the line:

> Coffee. The finest organic suspension ever devised... I beat the Borg with it.
> - Captain Janeway

效果如下：

Structured documents

Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a # to create headings. Multiple ## in a row denote smaller heading sizes.

This is a third-tier heading

You can use one # all the way up to ###### six for different heading sizes.

If you'd like to quote someone, use the > character before the line:

Coffee. The finest organic suspension ever devised... I beat the Borg with it.

• Captain Janeway

代码——code

There are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: `var example = true`.  If you've got a longer block of code, you can indent with four spaces:

    if (isAwesome){
      return true
    }

GitHub also supports something called code fencing, which allows for multiple lines without indentation:

```
if (isAwesome){
  return true
}
```

And if you'd like to use syntax highlighting, include the language:

```javascript
if (isAwesome){
  return true
}
```

效果如下

There are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: var example = true. If you've got a longer block of code, you can indent with four spaces:

if (isAwesome){
  return true
}

GitHub also supports something called code fencing, which allows for multiple lines without indentation:

if (isAwesome){
  return true
}

And if you'd like to use syntax highlighting, include the language:

if (isAwesome){
  return true
}

其他——Extras

GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath — love your sweater!

But I have to admit, tasks lists are my favorite:

- [x] This is a complete item
- [ ] This is an incomplete item

When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!

And, of course emoji! :sparkles: :camel: :boom:

效果如下

GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath — love your sweater!

But I have to admit, tasks lists are my favorite:

• [x] This is a complete item
• [ ] This is an incomplete item

When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!

And, of course emoji! ✨