轻巧 Markdown - 语法

Markdown 是一种方便记忆、书写的纯文本标记语言，用户可以使用这些标记符号以最小的输入代价生成极富表现力的文档：譬如您正在阅读的这份文档。它使用简单的符号标记不同的标题，分割不同的段落，粗体 或者 斜体 某些文字

轻巧 Markdown支持丰富的Markdown语法，已实现 Markdown Guide 所列举的基本及扩展语法，在此不加赘述，如有兴趣，可以参看：

• Basic Syntax
  The Markdown elements outlined in John Gruber's design document.
• Extended Syntax
  Advanced features that build on the basic Markdown syntax.

除上述语法外，轻巧Markdown还额外支持下述扩展语法：

KaTeX 公式

$ 表示行内公式：

质能守恒方程可以用一个很简洁的方程式 $E=mc^2$ 来表达。

$$ 表示整行公式:

$$\sum_{i=1}^n a_i=0 $$

$$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2$$

$$x = {-b \pm \sqrt{b^2-4ac} \over 2a}.$$

高亮标记

使用==标记文字==来对指定文本进行标记

如 我是一段被标记的文字

上标与下标

使用 ^搞事情^ 对文本进行上标处理，使用 ~下标~ 渲染出来是这样：

这是一段包含着^上标与_下标的文字

预设容器

软件提供了三种常用的自定义容器，分别是tip、warning、danger，使用方式如下

:::tip
我是一段提示文字
:::

::warning
我是一段警告文字
:::

::danger
我是一段危险警示文字
:::

UML绘图支持

UML是一种常用的绘图语言，可以方便地画出时序图、流程图、用例图等。

@startuml

title:时序图

== 鉴权阶段 ==

Alice -> Bob: 请求
Bob -> Alice: 应答

== 数据上传 ==

Alice -> Bob: 上传数据
note left: 这是显示在左边的备注

Bob --> Canny: 转交数据
... 不超过 5 秒钟 ...
Canny --> Bob: 状态返回
note right: 这是显示在右边的备注

Bob -> Alice: 状态返回

== 状态显示 ==

Alice -> Alice: 给自己发消息
@enduml

@startuml

left to right direction
actor 消费者
actor 销售员
rectangle 买单 {
消费者 -- (买单)
(买单) .> (付款) : include
(帮助) .> (买单) : extends
(买单) -- 销售员
}

@enduml

@startuml

title 流程图

start
:"步骤1处理";
:"步骤2处理";
if ("条件1判断") then (true)
    :条件1成立时执行的动作;
    if ("分支条件2判断") then (no)
        :"条件2不成立时执行的动作";
    else
        if ("条件3判断") then (yes)
            :"条件3成立时的动作";
        else (no)
            :"条件3不成立时的动作";
        endif
    endif
    :"顺序步骤3处理";
endif

if ("条件4判断") then (yes)
:"条件4成立的动作";
else
    if ("条件5判断") then (yes)
        :"条件5成立时的动作";
    else (no)
        :"条件5不成立时的动作";
    endif
endif
stop

@enduml