Markdown使用规范

发布时间 2023-11-27 17:06:07作者: HAOstudio

Markdown使用规范

0、使用VSCode编写Markdown代码

写在前面
使用一个好用的编辑器来编辑Markdown是很有必要的,这里推荐VSCode。
首先在VSCode上安装下图三个插件,并重启VSCode,便可以愉快的编写Markdown啦~

  • Markdown All in One
  • Markdown Preview Enhanced
  • Markdown Preview Github Styling

插件

1、正文段落

这是一段正文文字,直接编辑文字即可,换行需要在末尾添加两个以上空格再回车
这行就是换行后的文字。可以发现两空格加回车的换行方式会使两行紧挨在一起。

该行是与上面的段落隔了一个空行所形成的一个新的段落。可以发现与上面的段落有了一定的距离,可以看做一个新的段落。

2、标记

加粗文字:**粗体文字**-----粗体文字
斜体文字:*斜体文字*-----斜体文字
斜体加粗文字:***斜体粗体文字***-----斜体粗体文字
删除线文字:~~删除线文字~~-----删除线文字
删除线粗体文字:~~**删除线粗体文字**~~-----删除线粗体文字

3、分割线

使用三个及以上的星号(*)或者破折号(-)或者下划线(_),形成单独一行。


***
---
___

为保证兼容性,建议在分割线行上下都加上一个空行。

4、标题

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

上面的代码显示效果如下:
标题显示

为了保证兼容性,通过一个空格在#和标题之间进行分隔。

5、引用

一行以>开头,形成一段引用。

这是一句引用。
This is a reference.

6、列表

有序列表

以标号加小数点开头,形成有序列表。

1. First item
2. Second item
3. Third item
4. Fourth item

表现形式如下:

  1. First item
  2. Second item
  3. Third item
  4. Fourth item

无序列表

*或者+或者-开头,形成无序列表。

+ First item
+ Second item
+ Third item
+ Fourth item

表现形式如下:

  • First item
  • Second item
  • Third item
  • Fourth item

7、代码段

介绍一下如何在markdown中插入代码段。

段落内嵌代码

在正文中以两个`包含的内容为嵌入式代码:
在Arduino中,有两个函数:一个为setup()函数,另一个为loop()函数。

代码区块

以```开头,以```结尾,形成独立代码片段。

C语言风格如下:

#include <stdio.h>
int main()
{
   /* 我的第一个 C 程序 */
   printf("Hello, World! \n");

   return 0;
}

markdown风格如下:

# 一级标题
## 二级标题
### 三级标题
#### 四级标题

python代码风格如下:

print("hello world")

verilog代码风格如下:

wire [1:0] results ;
assign  results = (a == 1'b0) ? 2'b01 :
                 (b==1'b0) ? 2'b10 :
                 2'b11 ;

也可以使用 制表符(Tab) 或者 4个空格 来形成代码区块。

8、插入图片

![图片标题](图片链接 "可选的图片文本")
[![图片标题](图片链接 "可选的图片文本")](点击图片的超链接)

Markdown All in One
官方教程

图片链接可以是本地的绝对路径链接,可以是相对路径衔接,也可以是网络图片链接

9、插入链接

[超链接显示名](超链接地址 "超链接title")

这是一个链接 Markdown语法

10、公式

这是一个行内公式:\(y=ax+b\)

块内公式(LC谐振频率):

$$
F_{s} =\frac{1}{2\pi \sqrt{LC} } 
$$

\[F_{s} =\frac{1}{2\pi \sqrt{LC} } \]

矩阵:

$$
\begin{Bmatrix}
   a & b \\
   c & d
\end{Bmatrix}
$$

\[\begin{Bmatrix} a & b \\ c & d \end{Bmatrix} \]

11、表格

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
表头 表头
单元格 单元格
单元格 单元格
左对齐 右对齐 居中对齐
单元格 单元格 单元格
单元格 单元格 单元格

12、代办事项

- [x] 考英语六级
- [ ] 写论文
- [ ] 组会报告

13、列出全部标题TOC

TOC 全称为 Table of Content,列出全部标题。使用[TOC]命令列出。

参考资料和网址

  1. 菜鸟Markdown教程
  2. Markdown官方教程
  3. 在线的Markdown编辑器
  4. 在线的公式编辑器