【markdown】进阶用法

最新推荐文章于 2024-10-18 12:15:08 发布

small_Axe

最新推荐文章于 2024-10-18 12:15:08 发布

阅读量871

点赞数 1

分类专栏： markdown 文章标签： vscode 编辑器 javascript

本文链接：https://blog.csdn.net/houwhu/article/details/121858706

版权

markdown 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

本文详细介绍了Markdown的高级语法，包括内容目录、代码块增强、标签分类、待办事项、流程图和时序图的创建。通过MarkdownTOC插件实现自动生成目录，使用```js等语法实现代码高亮，利用mermaid库创建流程图和时序图，增强了Markdown文档的表现力和实用性。

摘要由CSDN通过智能技术生成

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

一、内容目录

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

例如本文目录：

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

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

vscode 使用 TOC

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

二、加强代码块

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

javascript 为例：

/*
 * @params: n > 0
 * @ a javascript factorial function;
 */
function factorial(n) {
  if (n === 1) return 1;
  return n * factorial(n - 1）;
}

/*
 * @params: n > 0
 * @ a javascript factorial function;
 */
function factorial(n) {
  if (n === 1) return 1;
  return n * factorial(n - 1）;
}

注：

由上面示例可见，利用```只是简单生成一个代码块, 用加强代码块+语言类型
 ```js 或者 ```javascript 标注后，就可以实现代码高亮显示。

三、标签和分类

一般在文首输入tags添加标签，categories添加分类:

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

四、待办事宜 Todo

使用带有 [ ] 或 [x] （未完成或已完成）项的列表语法撰写一个待办事宜列表例如：

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

五、流程图和时序图

1、流程图(flowchat)

1.1 基本语句：

tag=>type: content:>url

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

1.2 操作块

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

注意：冒号后要加空格

1.3 操作模块详细说明

1. #开始 start
   st=>start: 开始
   
2. #结束 start
   en=>end: 结束
   
3. #普通操作快 operation
   op1=>operation: 操作1
   op2=>operation: 操作2
   
4. #判断块 condition
cond1=>condition: 第一个判断
cond2=>condition: 第二个判断
    
5. #输入输出块 inputoutput
io1=>inputoutput: 输入输出块1
io2=>inputoutput: 输入输出块2
    
6. #子任务块
sub1=>subroutine: 子任务1
sub2=>subroutine: 子任务2

1.4 流程控制

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

1.5 FLOWCHAT示例

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

2、时序图(sequence)

2.1 示例

```mermaid
sequenceDiagram
对象A->>对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象A->>对象B: 你真的好吗？

2.2 流程控制

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

2.3 成员定义和别名

使用 participant 可定义成员，使用as 可以为成员定义别名。

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

六、公式

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

行内公式 $

质能守恒方程：$E = mc^2$ 表达

质能守恒方程： $E = mc^2$ 表达

整行公式 $$

$$ c = \sqrt{a^{2}+b_{xy}^{2} +e^{x}} $$

$\sqrt{a^{2}+b_{xy}^{2} +e^{x}}$

LaTex的公式规则

转义

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

$\boxed{E=mc^2}$

希腊字母表

上下标和根号

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

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

$\sqrt{x} \quad \sqrt[3]{y}$
其中\quad表示添加空格

分数

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

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

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

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

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

运算符

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