0x12 字符公式

• 数学公式使用时需要使用$包起来，$和$$切换使用，但是以此转化为的doc文件可能效果不理想

  • \[\textbf{加粗内容} 、 \text{空格：}\quad 也可以用斜杠 \ \pmb{\theta}_i\]

  • 常见希腊字符(一般小写首字母大写可以得到相应大写希腊字符) \(\alpha — \beta - \gamma - \delta - \tau - \eta - \theta - \mu - \phi -\Phi - \Gamma - \infty\)

  • 常用运算符，简单分式建议使用/ \(\sqrt n - \frac{a}{b} - \int_a^b - \sum_{a}^{b} - \sum\limits_{a}^{b} - \prod_{ab} - f'(x)\\ C^k_n = {n \choose k} \\ lim_{x \to \infty}多行\)

  • 多行 \(括号公式： \begin{cases} x=2\\ x-3 \end{cases}\\ 多行公式: \begin{gather} a \\ d \end{gather} \\ 矩阵 \begin{array}{cc} x & x+1\\ y & y+1 \end{array}\)

• 向量 \(\overrightarrow{a}=\overrightarrow{AB}=\vec{a}\)

• 关系符 \(< > = \le \leq \ge \geq \\ \equiv \sim \approx {\mid} \parallel \notin \overline{x} x' \propto \\ \bigcup \overline{x} \underline{x} \overbrace{x+y} \ \hat{a} \dot{a} \bar{a}\\ \nabla \ \mathrm{dx}\)

  • 省略号 \(\dots\)

• 矩阵 \(\\) \begin{matrix} 1 & x & x^2
  1 & y & y^2
  1 & z & z^2
  \end{matrix} $$ $$

  • 行列式 \(X=\left| \begin{matrix} x_{11} & x_{12} & \cdots & x_{1d}\\ x_{21} & x_{22} & \cdots & x_{2d}\\ \vdots & \vdots & \ddots & \vdots \\ x_{11} & x_{12} & \cdots & x_{1d}\\ \end{matrix} \right|\)
  • 分段函数 \(f(n)= \begin{cases} n/2, & \text{if $n$ is even}\\ 3n+1,& \text{if $n$ is odd} \end{cases}\)
  • \[\frac{\partial J(\theta)}{\partial\theta_j} = -\frac1m\sum_{i=0}^m(y^i - h_\theta(x^i))x^i_j\]
• \[J(\theta) = \frac{1}{2m}\sum_{i=0}^m(y^i - h_\theta(x^i))^2\]
  • \[H_c=\sum_{l_1+\dots +l_p}\prod^p_{i=1} \binom{n_i}{l_i}\]

• 推导过程 \(\begin{align} \frac{\partial J(\theta)}{\partial\theta_j} & = -\frac1m\sum_{i=0}^m(y^i - h_\theta(x^i)) \frac{\partial}{\partial\theta_j}(y^i-h_\theta(x^i))\\ & = -\frac1m\sum_{i=0}^m(y^i-h_\theta(x^i)) \frac{\partial}{\partial\theta_j}(\sum_{j=0}^n\theta_j x^i_j-y^i)\\ &=-\frac1m\sum_{i=0}^m(y^i -h_\theta(x^i)) x^i_j \end{align}\)

• λ μ φ reference

• © ® ×

• 如 > 等在 markdown 中含有标签作用的字符需要使用\来转义，或者使用HTML的实体符号

0x13 流程图

mermaid

• TB 从上到下
• BT 从下到上
• RL 从右到左
• LR 从左到右
• TD 同TB
• id + [文字描述]矩形
• id + (文字描述)圆角矩形
• id + >文字描述]不对称的矩形
• id + {文字描述}菱形
• id + ((文字描述))圆形

graph LR
    A[A] --> B[B] 
    A1[A] --- B1[B] 
    A4[A] -.- B4[B] 
    A5[A] -.-> B5[B] 
    A7[A] ==> B7[B] 
    A3[A] -- 描述 --> B3[B] 
    A8[A] == 描述 ==> B8[B] 

子流程图

graph TB
    c1-->a2
    subgraph one
    a1-->a2
    end
    subgraph two
    b1-->b2
    end
    subgraph three
    c1-->c2
    end

综合使用

graph LR
    start[开始] --> input[输入A,B,C]
    input --> conditionA{A是否大于B}
    conditionA -- YES --> conditionC{A是否大于C}
    conditionA -- NO --> conditionB{B是否大于C}
    conditionC -- YES --> printA[输出A]
    conditionC -- NO --> printC[输出C]
    conditionB -- YES --> printB[输出B]
    conditionB -- NO --> printC[输出C]
    printA --> stop[结束]
    printC --> stop
    printB --> stop

自定义样式

graph LR
    id1(Start)-->id2(Stop)
    style id1 fill:#f9f,stroke:#333,stroke-width:4px,fill-opacity:0.5
    style id2 fill:#ccf,stroke:#f66,stroke-width:2px,stroke-dasharray: 10,5

0x14 目录

[TOC]可以自动生成文档目录

0x15 TODO list

• This task is incomplete.
• This task is completed.

0x2 文档模板

0x20 开发模板

[TOC]
## 基础
> 路径

##相关接口
### 接口功能
 
| 方法 | 路径 |功能|开发者|时间
|------|------|-----|
|post| /server |添加服务器密码|李星帅|2018-8-8
 
### 参数说明
 
| 参数 |参数名 |注释|
|------|------|
|ip  | ip  | 服务器的管理网IP |

### 支持格式
> JSON

### 返回字段

### 调用例子
测试环境路径：http://xxx.xxxx.com/rest/v1/serverPwd/add
参数：
​```json
{
    ip:"192.168.66.1"
}
​```
返回结果：
​```json
{
    "code": 0,
    "info": "[rest] 添加设备密码成功"
}
​```