Markdown-vscode编写规则

2024-03-01 13:35:28

使用#号进行书写 h1~h6 标题

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

段落格式

字体

斜体

一个*号包裹是倾斜

加粗

两个*号包裹是加粗

斜体加粗

三个*号包裹是加粗加倾斜

分割线

用三个以上的*号或者-号或底线_代表分割线

删除线

段落上的文字如果需要添加删除线，只需要在文字的两端加上两个波浪线
比如说
~~删除线~~

下划线

下划线就需要通过 html 里面的标签实现
这是带下划线文本

换行

在 vscode 里面进行编辑的时候，使用两个空格加换行实现段落的换行

脚注

脚注是对文本的补充说明
书写方式：
[^要标注的文本] ：这是标注的内容
或者是这样[^或者是这样]

列表

无序列表

无序列表使用*号或者+号或者-号来标记，这些标记后面要添加一个空格然后才会起作用，包括标题标签

第一个
第二个
第三个

第一个
第二个
第三个

第一个
第二个
第三个

有序列表

有序列表使用数字加.号加空格隔开来表示，当你第一个标注属性出来之后，后面的序号只需要回车就会自动生成，无序列表也是这样

这是第一个
这是第二个
这是第三个

列表嵌套

列表嵌套只需要在子列表中的选项前面添加四个空格就行了，这四个空格的距离其实就是一个 tab 键的距离，直接使用 tab 就行了

这是第一项
- 这是嵌套的第一个元素
- 这是嵌套的第二个元素
- 这是嵌套的第三个元素
这是第二项
- 你看吧
- 确实是这样
- 真的是这样

区块

markdown 区块引用是在段落开头使用 > 符号，然后后面紧跟一个空格符号。再强调一次，两个空格表示换行，如果没有空格就不会换行

区块
一级标题
无序列表
有序列表

另外区块是可以嵌套的，一个 > 符号是最外层，两个 > 符号是第一层嵌套，以此类推：

第一级嵌套

第二级嵌套

第三集嵌套

区块中使用列表

区块

123

123

123

234

234

234

345

345

345

000

000

000

列表中使用区块

无序列表

区块
无序列表

在语法没问题的情况下可以随意嵌套书写

代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来（），例如：console.log()` 打印控制台

代码区块

使用四个空格或者一个制表符tab

btn.onclick=function () {
    console.log('感觉不大好用')
}

使用```三个反引号包裹，并指定语言，也可以不指定，感觉这种的比较好用

    btn.onclick=function() {
        console.log('感觉这种方式简单粗暴非常好用')
    }

链接

MarkDown链接使用方法：
链接名称

或者直接写
<链接地址>

比如说：

百度

https://www.baidu.com

两种方式就是一个带名字一个不带，直接挂上地址。上一种相当于使用a标签包裹了

高级链接

我们可以通过变量来设置一个链接，变量赋值在文档末尾进行
这是相当于在文章里面声明一个网址变量：
[百度][variate]

然后在文章的最末尾对这个网址变量进行赋值，以便于在整个文章中多次调用同一个网址（可以观察到在没有对网址变量进行赋值之前，那个链接调用是没用的）：
[variate]: http://www.baidu.com/

图片

Markdown图片语法格式

开头一个感叹号 !
接着一个方括号，里面放上图片的替代文字
接着一个普通括号，里面放上图片的网址，最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。

很明显，就是跟网页链接的使用方法一样。那么也就是说，网页链接的那个使用变量然后在末尾赋值的方法也同样适用，因为放的是网图的网络地址。

Markdown 还没有办法指定图片的高度与宽度，如果你需要的话，你可以使用普通的标签。可以对引用的图片进行设置宽高。

表格

Markdown 制作表格使用 | 来分隔不同的单元格，使用 - 来分隔表头和其他行。

右对齐	居中对齐	左对齐
单元格	单元格	单元格
单元格	单元格	单元格

对齐方式

我们可以设置表格的对齐方式：

-: 设置内容和标题栏居右对齐。就是冒号在最右边
:- 设置内容和标题栏居左对齐。冒号在最左边
:-: 设置内容和标题栏居中对齐。冒号两边都有

高级技巧

不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。

目前支持的 HTML 元素有：<kbd> </kbd>等

转义

Markdown 使用了很多特殊符号来表示特定的意义，如果需要显示特定的符号则需要使用转义字符，Markdown 使用反斜杠转义特殊字符：就是在特殊字符前面加个反斜杠\就行了
** 正常显示星号 **
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号：
\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号

公式

当你需要在编辑器中插入数学公式时，可以使用两个美元符包裹 T e X 或 L a T e X 格式的数学公式来实现。提交后，问答和文章页会根据需要加载 M a t h j a x 对数学公式进行渲染。如：没用啊大哥包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后，问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如：没用啊大哥包裹TeX或LaTeX格式的数学公式来实现。提交后，问答和文章页会根据需要加载Mathjax对数学公式进行渲染。如：没用啊大哥
\mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix}
\mathbf{i} & \mathbf{j} & \mathbf{k} \
\frac{\partial X}{\partial u} & \frac{\partial Y}{\partial u} & 0 \
\frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0 \
\end{vmatrix}
KaTeX parse error: Expected '}', got 'EOF' at end of input: {tep1}{\style{visibility:hidden}{(x+1)(x+1)}}
$$

流程图

1、横向流程图源码格式：

2、竖向流程图源码格式：

3、标准流程图源码格式：

4、标准流程图源码格式（横向）：

5、UML时序图源码样例：

6、UML时序图源码复杂样例：

7、UML标准时序图样例：

8、甘特图样例：

%% 语法示例
        gantt
        dateFormat  YYYY-MM-DD
        title 软件开发甘特图
        section 设计
        需求                      :done,    des1, 2014-01-06,2014-01-08
        原型                      :active,  des2, 2014-01-09, 3d
        UI设计                     :         des3, after des2, 5d
    未来任务                     :         des4, after des3, 5d
        section 开发
        学习准备理解需求                      :crit, done, 2014-01-06,24h
        设计框架                             :crit, done, after des2, 2d
        开发                                 :crit, active, 3d
        未来任务                              :crit, 5d
        耍                                   :2d
        section 测试
        功能测试                              :active, a1, after des3, 3d
        压力测试                               :after a1  , 20h
        测试报告                               : 48h

                         :crit, active, 3d
    未来任务                              :crit, 5d
    耍                                   :2d
    section 测试
    功能测试                              :active, a1, after des3, 3d
    压力测试                               :after a1  , 20h
    测试报告                               : 48h

码农公寓