title: Markdown

Markdown 语法

什么是Markdown语法?

Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。Markdown是一种轻量级标记语言,目标是实现「易读易写」

标题

在Markdown中,你只需要在文本前面加上# 即可,同理、你还可以增加二级标题、三级标题、四级标题、五级标题和六级标题,总共六级,只需要增加# 即可,标题字号相应降低。例如:

  1. # 一级标题
  2. ## 二级标题
  3. ### 三级标题
  4. #### 四级标题
  5. ##### 五级标题
  6. ###### 六级标题

锚点

Coding 会针对每个标题,在解析时都会添加锚点id,如

  1. # 锚点

会被解析成:

  1. <h1 id="user-content-锚点">锚点</h1>

注意我们添加了一个user-content-的前缀所以如果要自己添加跳转链接要使用markdown的形式,且链接要加一个’user-content-‘前缀,如:

  1. [问内链接](#user-content-锚点);

引用

Markdown 标记区块引用是使用类似 email 中用 > 的引用方式,只需要在整个段落的第一行最前面加上 > :

  1. > Coding.net 为软件开发者提供基于云计算技术的软件开发平台,包括项目管理,代码托管,运行空间和质量控制等等。

区块引用可以嵌套,只要根据层次加上不同数量的 > :

  1. > 这是第一级引用。
  2. >
  3. > > 这是第二级引用。
  4. >
  5. > 现在回到第一级引用。

引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等:

  1. > ## 这是一个标题。
  2. >
  3. > 1. 这是第一行列表项。
  4. > 2. 这是第二行列表项。
  5. >
  6. > 给出一些例子代码:
  7. >
  8. > return shell_exec("echo $input | $markdown_script");

列表

列表项目标记通常放在最左边,项目标记后面要接一个字符的空格。 无序列表:使用星号、加号或是减号作为列表标记

  1. - Red
  2. - Green
  3. - Blue

有序列表:使用数字接着一个英文句点

  1. 1. Red
  2. 2. Green
  3. 3. Blue

如果要在列表项目内放进引用,那 > 就需要缩进:

  1. * Coding.net有以下主要功能:
  2. > 代码托管平台
  3. > 在线运行环境
  4. > 代码质量监控
  5. > 项目管理平台

代办列表: 表示列表是否勾选状态

  1. - [ ] 不勾选
  2. - [x] 勾选

代码

只要把你的代码块包裹在 ``` 之间,你就不需要通过无休止的缩进来标记代码块了。 在围栏式代码块中,你可以指定一个可选的语言标识符,然后我们就可以为它启用语法着色了。 举个例子,这样可以为一段 Ruby 代码着色:

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

强调

在Markdown中,可以使用 * 和 _ 来表示斜体和加粗。

斜体:

  1. *Coding,让开发更简单*
  2. _Coding,让开发更简单_

加粗:

  1. **Coding,让开发更简单**
  2. __Coding,让开发更简单__

自动链接

方括号显示说明,圆括号内显示网址, Markdown 会自动把它转成链接,例如:

  1. [Github首页](https://github.com/)

或者也可以直接用< >,将网址或者邮箱地址放在中间,也能将地址直接转成链接:

  1. <support@coding.net>

表格

在 Markdown 中,可以制作表格,例如:

  1. First Header | Second Header | Third Header
  2. ------------ | ------------- | ------------
  3. Content Cell | Content Cell | Content Cell
  4. Content Cell | Content Cell | Content Cell

或者也可以让表格两边内容对齐,中间内容居中,例如:

  1. First Header | Second Header | Third Header
  2. :----------- | :-----------: | -----------:
  3. Left | Center | Right
  4. Left | Center | Right

分割线

在 Markdown 中,可以制作分割线,例如:

  1. ---

上下标

\^表示上标, _表示下标。如果上下标的内容多于一个字符,要用{}把这些内容括起来当成一个整体。上下标是可以嵌套的,也可以同时使用。 例如:

  1. x^{y^z}=(1+{\rm e}^x)^{-2xy^w}

图片

Markdown 使用了类似链接的语法来插入图片, 包含两种形式: 内联 和 引用.

内联图片语法如下:

  1. ![Alt text](/path/to/img.jpg)

  1. ![Alt text](/path/to/img.jpg "Optional title")

也就是:

一个感叹号: ! ; 紧跟一对方括号, 包含了可选填的图片 alt 属性; 紧跟一对圆括号, 包含了图片的 URL 或者路径, 以及一个可选的用单引号或双引号包裹的 title 属性.

引用图片语法如下:

  1. ![Alt text][id]

“id” 是图片引用的名称. 图片引用使用链接定义的相同语法:

  1. [id]: url/to/image "Optional title attribute"

标题

  1. ---
  2. title:标题
  3. ---