例子

文本

使用 Markdown 可以很容易地给一些文字设置**粗体**,其他文字设置*斜体*。你甚至可以 [链接到谷歌](http://google.com)!

使用 Markdown 可以很容易地给一些文字设置粗体,其他文字设置_斜体_。你甚至可以 链接到谷歌

列表

有时你想要有序列表:

1. 一
2. 二
3. 三

有时你想要突出要点:

* 使用星号开始一行
* 利润!

或者,

- 横杠也是可以的
- 如果还有下一级,在横杠或星号前输入两个空格:
  - 像这样
  - 还有这样

有时你想要有序列表:

有时你想要突出要点:

  • 使用星号开始一行

  • 利润!

或者,

  • 横杠也是可以的

  • 如果还有下一级,在横杠或星号前输入两个空格:

    • 像这样

    • 还有这样

图片

如果你想嵌入图片,可以这样做:

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

如果你想嵌入图片,可以这样做:

标题 & 引用

# 结构化文档

有时,使用不同级别的标题来组织文档是很有用的。用 `#` 开始作为标题。连续多个 `##` 表示较小的标题。

### 这是一个三级标题

你可以使用 `#` 到 `######` 六种不同大小的标题。

如果你想要引用他人的文字,使用 > 开头:

> 咖啡。有史以来最好的有机悬浮液……我用它击败了 Borg。
> ——Janeway 船长

结构化文档

有时,使用不同级别的标题来组织文档是很有用的。用 # 开始作为标题。连续多个 ## 表示较小的标题。

这是一个三级标题

你可以使用 ####### 六种不同大小的标题。

如果你想要引用他人的文字,使用 > 开头:

咖啡。有史以来最好的有机悬浮液……我用它击败了 Borg。

——Janeway 船长

代码

使用 GitHub 的 markdown 来装饰代码的方式有很多种。如果你有行内代码,请用反引号包住它们:`var example = true`。如果你有一个更长的代码块,你可以缩进四个空格:

    if (isAwesome){
      return true
    }

GitHub 还支持称为代码防护的东西,它允许多行而不缩进:

if (isAwesome){ return true }


如果你想使用语法高亮,则写上语言类型:

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

使用 GitHub 的 markdown 来装饰代码的方式有很多种。如果你有行内代码,请用反引号包住它们:`var example = true`。如果你有一个更长的代码块,你可以缩进四个空格:

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

GitHub 还支持称为代码防护的东西,它允许多行而不缩进:

if (isAwesome){
  return true
}

如果你想使用语法高亮,则写上语言类型:

if (isAwesome){
  return true
}

其他

GitHub 支持 Markdown 中的许多额外功能,可以帮助你引用链接别人。如果你想对某人发表评论,你可以在他们的名字前加上@符号:嘿@kneath ——你的毛衣不错!

我必须承认,待办事项是我最喜欢的:

- [x] 这是已完成的事项
- [ ] 这是未完成的事项

当你在 Issue 的第一条评论中包含任务列表时,你会在任务列表中看到一个有用的进度条。它也适用于拉取请求!

当然,emoji 也是支持的!

GitHub 支持 Markdown 中的许多额外功能,可以帮助你引用链接别人。如果你想对某人发表评论,你可以在他们的名字前加上@符号:嘿@kneath ——你的毛衣不错!

我必须承认,待办事项是我最喜欢的:

当你在 Issue 的第一条评论中包含任务列表时,你会在任务列表中看到一个有用的进度条。它也适用于拉取请求!

当然,emoji 也是支持的!

Last updated