Markdown 是一种轻量级标记语言,能够让作者使用易读易写的纯文本格式编写文档。CODING 许多功能模块均采用了 Markdown 语法,例如任务、需求、Wiki 等。

标题

在文本内容最左侧添加【#】即可实现标题格式。一个 【#】为一级标题,两个【#】为二级标题,以此类推。Markdown 共支持六级标题。(【#】与文本内容之间需间隔一个空格)

示例:

这是一级标题

这是二级标题

这是三级标题

这是四级标题

这是五级标题
这是六级标题

强调

加粗 在需要加粗的文本内容两侧分别添加【**】或【__】。

斜体 在需要倾斜的文本内容两侧分别添加【*】或【_】。

斜体加粗 在需要斜体加粗的文本内容两侧分别添加【***】。

删除线 在需要删除线标注的文本内容两侧分别添加【~~】。

示例:

加粗 加粗

斜体 斜体

斜体加粗

删除线

引用

在文本内容最左侧添加【>】即可实现引用格式,且引用支持嵌套,只需根据层次加上不同数量的【>】,即可实现对应层级的嵌套。

示例:

这是一级嵌套

这是二级嵌套

这是三级嵌套

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

示例:

  • 这是第一行列表项
  • 这是第二行列表项
  • return shell_exec(echo $input | $markdown_script)

列表

列表标记通常放在文本内容最左侧,且列表标记与文本内容之间需间隔一个空格。

无序列表

在文本内容左侧使用【*】、【+】或【-】作为无序列表标记,且列表标记与文本内容之间需间隔一个空格。

示例:

  • 无序列表
  • 无序列表

有序列表

在文本内容左侧使用【数字+英文句号】作为有序列表标记,且英文句号与文本内容之间需间隔一个空格。

示例:

  1. 有序列表
  2. 有序列表

代办列表

代办列表表示列表是否为勾选状态,在文本内容左侧使用【“-”+“X 或者空格”+内容】作为代办列表标记,且 “[]” 左右两侧均需要间隔一个空格。

示例:

  • 代办列表
  • 代办列表

代码

把代码块包裹在特定符号之间,即可免去通过无休止的缩进来标记代码块的繁琐方式。在围栏式代码块中,可以指定一个可选的语言标识符,为其启用语法着色。 举个例子,以下方式可以为一段 JS 代码着色:

示例:```js console.log("Hello World!"); ```

console.log("Hello World!");

表格

示例:

| First Header | Second Header | Third Header |
| :----------- | :-----------: | -----------: |
| Left | Center | Right |
First HeaderSecond HeaderThird Header
LeftCenterRight

图片

Markdown 使用了类似链接的语法来插入图片,用户可以直接复制图片粘贴至 Markdown 编辑框,系统将自动生成图片语法。

例如:![](./markdown.jpeg)

超链接

方括号内填写【超链接名】,圆括号内填写【链接】, Markdown 语法将自动将其转换为超链接。

例如:[Career](https://github.com/idrex/career)

Career

其他

特殊符号

© & ¨ ™ ¡ £ & < > ¥ € ® ± ¶ § ¦ ¯ « ·

X² Y³ ¾ ¼ × ÷ »

18ºC " '

数学符号

上标:X2,下标:O2