写作语法指南

基本语法

段落

Markdown标准语法:这是内嵌 python 代码, 这是加粗这是斜体,这是链接:https://docs.python.org

Markdown常用扩展语法:这是删除线 ,==高亮显示==,^^下划线^^ ,下标:H~2~O,上标:x^2^+y^2^=z,内嵌公式:\(\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.\)

无序列表

  • 一级无序列表

  • 一级无序列表

    • 二级无序列表

    • 二级无序列表

      • 三级无序列表

      • 三级无序列表

有序列表

  1. 一级有序列表

  2. 一级有序列表

    1. 二级有序列表

    2. 二级有序列表

      1. 三级有序列表

      2. 三级有序列表

代码

# 代码测试
import os

def func(a, b):
    r = a + b
    return r

if __name__ == '__main__':
    func(1, 2)

引用

这是一个普通的引用。

这是一个普通的引用。

表格

Method

Description

GET

:material-check: Fetch resource

PUT

:material-check-all: Update resource

DELETE

:material-close: Delete resource

公式

\[ \operatorname{ker} f=\{g\in G:f(g)=e_{H}\}{\mbox{.}} \]

扩展语法

警告

备注

这是一个 note 标记。没有自定义标题。

这是 note 标题

这是一个 note 标记。自定义标题。

Look ma! A custom title.

这是一个 admonition 标记。自定义标题。

attention

这是一个 attention 标记。自定义标题。

caution

这是一个 caution 标记。自定义标题。

danger

这是一个 danger 标记。自定义标题。

error

这是一个 error 标记。自定义标题。

hint

这是一个 hint 标记。自定义标题。

important

这是一个 important 标记。自定义标题。

note

这是一个 note 标记。自定义标题。

seealso

这是一个 seealso 标记。自定义标题。

tip

这是一个 tip 标记。自定义标题。

todo

这是一个 todo 标记。自定义标题。This needs the sphinx.ext.todo extension.

warning

这是一个 warning 标记。自定义标题。