Markdown 语法介绍

Markdown 语法介绍

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

标题

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

示例:

效果如下:

强调

加粗

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

斜体

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

斜体加粗

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

删除线

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

示例:

效果如下:

引用

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

示例:

效果如下:

这是一级嵌套

这是二级嵌套

这是三级嵌套

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

示例:

效果如下:

  • 这是第一行列表项

  • 这是第二行列表项

  • return shell_exec(echo $input | $markdown_script)

列表

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

无序列表

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

有序列表

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

示例:

效果如下:

代办列表

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

示例:

效果如下:

代码

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

效果如下:

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

表格

示例:

效果如下:

First Header Second Header Third Header
Left Center Right

 

图片

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

图片语法举例:

超链接

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

效果如下:

全新 CODING 涵盖了软件开发从构想到交付的一切所需,使研发团队在云端高效协同,实践敏捷开发与 DevOps,提升软件交付质量与速度。点此体验

数学公式

CODING Markdown 编辑器已支持 katex 服务,公式语法可参考:https://katex.org/

示例:

$$ f(x) = \int _{-\infty}^\infty \hat f(\xi)\, e^{2 \pi i \xi x} \, d\xi$$

 

效果如下:

流程图

Markdown 编辑器已支持绘制流程图、时序图和甘特图,通过 mermaid 实现图形的插入。点击查看 更多语法详情

示例:

```graph
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->E;
    E-->F;
    D-->F;
    F-->G;
```

 

效果如下:

时序图

示例:

```graph
sequenceDiagram
    participant Alice
    participant Bob
    Alice->John: Hello John, how are you?
    loop Healthcheck
        John->John: Fight against hypochondria
    end
    Note right of John: Rational thoughts 
prevail...
    John-->Alice: Great!
    John->Bob: How about you?
    Bob-->John: Jolly good!
```

 

效果如下:

甘特图

示例:

```graph
gantt
        dateFormat  YYYY-MM-DD
        title Adding GANTT diagram functionality to mermaid
        section A section
        Completed task            :done,    des1, 2014-01-06,2014-01-08
        Active task               :active,  des2, 2014-01-09, 3d
        Future task               :         des3, after des2, 5d
        Future task2              :         des4, after des3, 5d
        section Critical tasks
        Completed task in the critical line :crit, done, 2014-01-06,24h
        Implement parser and jison          :crit, done, after des1, 2d
        Create tests for parser             :crit, active, 3d
        Future task in critical line        :crit, 5d
        Create tests for renderer           :2d
        Add to mermaid                      :1d
```

 

效果如下:

相关文章