Markdown 基本要素

这篇文件意在简要介绍 GitHub Flavored Markdown 写作。

什么是 Markdown?

Markdown 是一种文本格式。你可以用它来控制文档的显示。使用 markdown，你可以创建粗体的文字，斜体的文字，添加图片，并且创建列表 等等。基本上来讲，Markdown 就是普通的文字加上 # 或者 * 等符号。

语法说明

标题

  1. # 这是 <h1> 一级标题
  2. ## 这是 <h2> 二级标题
  3. ### 这是 <h3> 三级标题
  4. #### 这是 <h4> 四级标题
  5. ##### 这是 <h5> 五级标题
  6. ###### 这是 <h6> 六级标题

如果你想要给你的标题添加 id 或者 class，请在标题最后添加 {#id .class1 .class2}。例如： 

  1. # 这个标题拥有 1 个 id {#my_id}
  2. # 这个标题有 2 个 classes {.class1 .class2}

这是一个 MPE 扩展的特性。

强调

  1. *这会是 斜体 的文字*
  2. _这会是 斜体 的文字_
  4. **这会是 粗体 的文字**
  5. __这会是 粗体 的文字__
  7. _你也 **组合** 这些符号_
  9. ~~这个文字将会被横线删除~~

列表

无序列表

  1. * Item 1
  2. * Item 2
  3.   * Item 2a
  4.   * Item 2b

有序列表

  1. 1. Item 1
  2. 1. Item 2
  3. 1. Item 3
  4.    1. Item 3a
  5.    1. Item 3b

添加图片

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

链接

  1. http://github.com - 自动生成！
  2. [GitHub](http://github.com)

引用

  1. 正如 Kanye West 所说：
  3. > We're living the future so
  4. > the present is our past.

分割线

  1. 如下，三个或者更多的
  3. ---
  5. 连字符
  7. ***
  9. 星号
  11. ___
  13. 下划线

行内代码

  1. 我觉得你应该在这里使用
  2. `<addr>` 才对。

代码块

你可以在你的代码上面和下面添加 ``` 来表示代码块。

语法高亮

你可以给你的代码块添加任何一种语言的语法高亮

例如，给 ruby 代码添加语法高亮：

  1. ```ruby
  2. require 'redcarpet'
  3. markdown = Redcarpet.new("Hello World!")
  4. puts markdown.to_html
  5. ```

会得到下面的效果：

  1. require 'redcarpet'
  2. markdown = Redcarpet.new("Hello World!")
  3. puts markdown.to_html

代码块 class（MPE 扩展的特性）

你可以给你的代码块设置 class。

例如，添加 class1 class2 到一个 代码块：

  1. ```javascript {.class1 .class}
  2. function add(x, y) {
  3.   return x + y
  4. }
  5. ```
代码行数

如果你想要你的代码块显示代码行数，只要添加 line-numbers class 就可以了。

例如：

  1. ```javascript {.line-numbers}
  2. function add(x, y) {
  3.   return x + y
  4. }
  5. ```

将会得到下面的显示效果：

screen shot 2017-07-14 at 1 20 27 am

任务列表

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

表格

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

扩展的语法

表格

screen shot 2017-07-15 at 8 16 45 pm

Emoji & Font-Awesome

只适用于 markdown-it parser 而不适用于 pandoc parser。
缺省下是启用的。你可以在插件设置里禁用此功能。 

  1. :smile:
  2. :fa-car:

上标

  1. 30^th^

下标

  1. H~2~O

脚注

  1. Content [^1]
  3. [^1]: Hi! This is a footnote

缩略

  1. *[HTML]: Hyper Text Markup Language
  2. *[W3C]:  World Wide Web Consortium
  3. The HTML specification
  4. is maintained by the W3C.

标记

  1. ==marked==

CriticMarkup

CriticMarkup 缺省是禁用的，你可以通过插件设置来启动它。
有关 CriticMarkup 的更多信息，请查看 CriticMarkup 用户指南.

这里有 5 种基本语法：

  • 添加 {++ ++}
  • 删除 {-- --}
  • 替换 {~~ ~> ~~}
  • 注释 {>> <<}
  • 高亮 {== ==}{>> <<}

CriticMarkup 仅可用于 markdown-it parser，不与 pandoc parser 兼容。

参考

➔ 数学