【Markdown】高级应用技巧与实践

注&＃xff1a;写博客或者项目的 README 文档经常用到 markdown 语法&＃xff0c;所以markdown的语法做了一个总结&＃xff0c;本文是基于 【markdown】基本语法的进阶语法。

一、内容目录

使用[TOC]引用目录,各种编辑器对[toc]的支持不一样&＃xff0c;需通过插件支持。

例如本文目录&＃xff1a;

&＃64;[toc](markdown高阶语法)
## 内容目录
### vscode 使用 TOC
## 我是标题2


在文章你想生成目录的地方使用 [toc] 或 &＃64;[TOC](目录标题) 来生成目录。目录效果见文章上部目录。

vscode 使用 TOC

使用 ctrl &＃43; shift &＃43; x 打开应用商店&＃xff0c;搜索拓展插件 Markdown TOC&＃xff0c;点击下载。点击鼠标右键&＃xff0c;发现选项栏里多了四个markdown相关的选项&＃xff0c;点击 Markdown TOC:Insert/Update生成目录。

二、加强代码块

在基础用法里提过代码块的使用是&＃96;&＃96;&＃96;来包裹内容实现&＃xff0c;加强代码块是在其基础上加上语言名称进行标记。

• Javascript 为例&＃xff1a;

/** &＃64;params: n > 0* &＃64; a Javascript factorial function;*/
function factorial(n) {if (n &＃61;&＃61;&＃61; 1) return 1;return n * factorial(n - 1&＃xff09;;
}


/** &＃64;params: n > 0* &＃64; a Javascript factorial function;*/
function factorial(n) {if (n &＃61;&＃61;&＃61; 1) return 1;return n * factorial(n - 1&＃xff09;;
}


注&＃xff1a;

由上面示例可见&＃xff0c;利用&＃96;&＃96;&＃96;只是简单生成一个代码块, 用加强代码块&＃43;语言类型&＃96;&＃96;&＃96;js 或者 &＃96;&＃96;&＃96;Javascript 标注后&＃xff0c;就可以实现代码高亮显示。


三、标签和分类

一般在文首输入tags添加标签&＃xff0c;categories添加分类:

tags: - Markdown- 语言categories:- 技术


四、待办事宜 Todo

使用带有 [ ] 或 [x] &＃xff08;未完成或已完成&＃xff09;项的列表语法撰写一个待办事宜列表例如&＃xff1a;

• 早起晨跑
• 吃早餐
• 上班

五、流程图和时序图

1、流程图(flowchat)

1.1 基本语句&＃xff1a;

tag&＃61;>type: content:>url


• tag 就是元素名称。
• type是这个元素的类型&＃xff0c;有下面类型&＃xff0c;分别为:
  1. 开始&＃xff08;椭圆形&＃xff09;&＃xff1a;start
  2. 结束&＃xff08;椭圆形&＃xff09;&＃xff1a;end
  3. 操作&＃xff08;矩形&＃xff09;&＃xff1a;operation
  4. 条件判断&＃xff08;菱形&＃xff09;&＃xff1a;condition
  5. 输入输出&＃xff08;平行四边形&＃xff09;&＃xff1a;inputoutput
  6. 预处理/子程序&＃xff08;圣旨形&＃xff09;&＃xff1a;subroutine

1.2 操作块

st&＃61;>start: 开始1. st 是变量名&＃xff0c;类似php中数组索引&＃xff0c;可以用英文&＃xff0c;别定义的太离谱就行&＃xff0c;如op_this,cond_echo
2. start 操作模块名&＃xff0c;像数据类型 Int String&＃xff0c;如&＃xff1a;开始&＃xff0c;结束&＃xff0c;判断。命名严格&＃xff0c;区别大小写。
3. 后面是要显示的文字


注意&＃xff1a;冒号后要加空格

1.3 操作模块详细说明

1. #开始 startst&＃61;>start: 开始2. #结束 starten&＃61;>end: 结束3. #普通操作快 operationop1&＃61;>operation: 操作1op2&＃61;>operation: 操作24. #判断块 condition
cond1&＃61;>condition: 第一个判断
cond2&＃61;>condition: 第二个判断5. #输入输出块 inputoutput
io1&＃61;>inputoutput: 输入输出块1
io2&＃61;>inputoutput: 输入输出块26. #子任务块
sub1&＃61;>subroutine: 子任务1
sub2&＃61;>subroutine: 子任务2


1.4 流程控制

1. 流程控制-> 作为控制流程的操作符&＃xff0c;就是指向下一步要操作的# st->op->e// 也可以分开写st->opop->e
2. 判断控制cond(yes)->op // yes 的时候回到 opcond(no)-e // no的时候结束cond(yes)->op(right) // 控制 op 位置于右边,也可以写成cond(yes, right)->op


1.5 FLOWCHAT示例

&＃96;&＃96;&＃96;mermaid
flowchat
st&＃61;>start: 开始框
op&＃61;>operation: 处理框
cond&＃61;>condition: 判断框(是或否?)
sub1&＃61;>subroutine: 子流程
io&＃61;>inputoutput: 输入输出框
e&＃61;>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op


2、时序图(sequence)

2.1 示例

&＃96;&＃96;&＃96;mermaid
sequenceDiagram
对象A->>对象B: 对象B你好吗?&＃xff08;请求&＃xff09;
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象A->>对象B: 你真的好吗&＃xff1f;


2.2 流程控制

"-" 表示实线
"--" 表示虚线
">" 表示黑体箭头
">>" 表示空心箭头


2.3 成员定义和别名

使用 participant 可定义成员&＃xff0c;使用as 可以为成员定义别名。

title:成员定义
participant Client // 定义一个名叫client的成员
participant clinet as cl // 定义一个名叫client的成员别名(简称)cl


六、公式

当你需要在编辑器中插入数学公式时&＃xff0c;可以使用两个美元符 $$ 包裹 LaTeX 格式的数学公式来实现。

行内公式 $

质能守恒方程&＃xff1a;$E &＃61; mc^2$ 表达


质能守恒方程&＃xff1a;E&＃61;mc2E &＃61; mc^2E&＃61;mc2 表达

整行公式 $$

$$ c &＃61; \sqrt{a^{2}&＃43;b_{xy}^{2} &＃43;e^{x}} $$


c&＃61;a2&＃43;bxy2&＃43;exc &＃61; \sqrt{a^{2}&＃43;b_{xy}^{2} &＃43;e^{x}} c&＃61;a2&＃43;bxy2​&＃43;ex

​

LaTex的公式规则

转义

以下几个字符:# $ % & ~ _ ^ \ { }有特殊意义&＃xff0c;需要表示这些字符时&＃xff0c;需要转义&＃xff0c;即在每个字符前加上\。
\boxed 命令给公式加一个方框。

E&＃61;mc2\boxed{E&＃61;mc^2}E&＃61;mc2​

希腊字母表

上下标和根号

用 ^ 来表示上标
用 _ 来表示下标
用 \sqrt 表示根号
注意&＃xff1a;上下标如果多余一个字符或符号&＃xff0c;需要用{}括起来。 \sqrt[开方次数&＃xff0c;默认为2

$$\sqrt{x} \quad \sqrt[3]{y}$$


xy3\sqrt{x} \quad \sqrt[3]{y}x

​3y

​
其中\quad表示添加空格

分数

分数用\frac表示
字号工具环境设置&＃xff1a;
\dfrac命令把字号设置为独立公式中的大小&＃xff1b;
\tfrac则把字号设置为行间公式中的大小。

$ \frac{1}{2} \dfrac{1}{2} $


1212\frac{1}{2} \dfrac{1}{2}21​21​

$$ \frac{1}{2} \tfrac{1}{2} $$


1212\frac{1}{2} \tfrac{1}{2} 21​21​

运算符

• &＃43; - * / &＃61;直接输入&＃xff1b;
• 特殊运算则用以下特殊命令\pm; \times; \div; \cdot; \cap; \cup; \geq; \leq; \neq; \approx; \equiv
• 和、积、极限、积分等运算符用\sum, \prod, \lim, \int,这些公式在行内公式被压缩&＃xff0c;以适应行高&＃xff0c;可以通过\limits和\nolimits命令显示制动是否压缩