Markdown示例

Markdown是一种轻量级标记语言,使用易读易写的纯文本格式,通过简单的标记符号来实现文档的格式化,包括标题、列表、链接、图片等。被广泛用于编写各种文档,例如博客、论坛帖子、README文件等。其一大优势是可以轻松转换为HTML等其他格式,更为灵活方便地在不同平台上展示内容。

摘要

Markdown是一种轻量级标记语言,使用易读易写的纯文本格式,通过简单的标记符号来实现文档的格式化,包括标题、列表、链接、图片等。被广泛用于编写各种文档,例如博客、论坛帖子、README文件、技术文档等。Markdown的一大优势是可以轻松转换为HTML等其他格式,使得内容在不同平台上展示更为灵活方便。 本文介绍了一些Markdown的简单用法以及示例,包括文本格式、标题、列表、表格、链接、图片、引用、代码、分割线、注脚、数学公式等。

基础操作

对于Markdown的基础操作,主要包括文本格式、标题、列表、表格、链接和图片等,能满足大部分的文档需求。

文本格式

文字样式

使用**粗体**__粗体__加粗显示字体 粗体

使用*斜体*_斜体_ 表示斜体

使用~~删除线~~ 在字体上添加删除线删除线

文字大小

字体大小通常通过使用HTML的<h1>~<h6>标签或者<span>标签,并结合CSS样式来实现 例如:<h2>这是h1大小的字体<h2>,或者结合CSS样式:

1
<span style="font-size:20px;">这是20像素大小的字体</span>

文本换行或段落

在行尾添加两个或更多的空格,然后按回车键进行换行

1
2
这是第一行。  
这是第二行。

创建一个新的段落可以在行尾按回车键两次。

1
2
3
这是第一段。

这是第二段。

标题

一个#表示一级标题,两个#表示二级标题,以此类推,最多支持六级标题。

1
2
3
4
5
6
# 标题 1
## 标题 2
### 标题 3
#### 标题 4
##### 标题 5
###### 标题 6

列表

无序列表

使用*+-表示无序列表,例如:

1
2
3
4
- 项目 1
- 项目 2
- 子项目 2.1
- 子项目 2.2

  • 项目 1
  • 项目 2
    • 子项目 2.1
    • 子项目 2.2

有序列表

使用数字加.表示有序列表,例如:

1
2
3
4
1. 第一步
2. 第二步
1. 子步骤 2.1
2. 子步骤 2.2

  1. 第一步
  2. 第二步
    1. 子步骤 2.1
    2. 子步骤 2.2

表格

在线编辑工具:表格生成器 ### markdown表格 使用|-来创建表格,例如:

1
2
3
4
| 列1标题 | 列2标题 | 列3标题 |
| ------- | ------- | ------- |
| 行1列1 | 行1列2 | 行1列3 |
| 行2列1 | 行2列2 | 行2列3 |

列1标题 列2标题 列3标题
行1列1 行1列2 行1列3
行2列1 行2列2 行2列3

html表格

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<table>
<tr>
<td colspan="2" style="text-align: center;vertical-align:middle;">数据类型</td>
<td>长度(位)</td>
</tr>
<tr>
<td rowspan="4" style="text-align: center;vertical-align:middle;">整数类型</td>
<td>byte</td>
<td>8</td>
</tr>
<tr>
<td>short</td>
<td>16</td>
</tr>
<tr>
<td>int</td>
<td>32</td>
</tr>
<tr>
<td>long</td>
<td>64</td>
</tr>
<tr>
<td rowspan="2" style="text-align: center;vertical-align:middle;">浮点类型</td>
<td>float</td>
<td>32</td>
</tr>
<tr>
<td>double</td>
<td>64</td>
</tr>
<tr>
<td style="text-align: center;vertical-align:middle;">字符型</td>
<td>char</td>
<td>16</td>
</tr>
<tr>
<td style="text-align: center;vertical-align:middle;">布尔型</td>
<td>boolean</td>
<td>~</td>
</tr>
</table>
数据类型 长度(位)
整数类型 byte 8
short 16
int 32
long 64
浮点类型 float 32
double 64
字符型 char 16
布尔型 boolean ~
1 2 33 4 5 6 7 8
8 7 54 32 23

链接和图片

链接和图片的语法类似,区别在于链接使用[](),而图片使用![](),例如:

1
2
3
插入链接:[MarkDown测试](https://beanljun.top/2024/03/13/test2/#more)
插入链接:[域名测试](https://beanljun.top)
插入图片:![图床测试](https://cdn.beanljun.top/gh/beanljun/imgs/blog/res/grabentest.jpg)

MarkDown测试

域名测试

图床测试

进阶操作

Markdown的功能远不止以上这些,还有引用、代码、分割线、注脚、数学公式等功能,可以满足更多的文档需求,使用这些功能可以让文档更加丰富多样,更加符合个人的审美和需求。 ## 引用 使用>表示引用,例如:

1
> 这是一个引用文本示例。
> 这是一个引用文本示例。

代码

内联代码使用反引号包裹,例如:code

代码块使用三个反引号包裹,后面跟上语言名称,例如:

1
2
def hello_world():
print("Hello, World!")
1
2
3
4
5
6
7
8
TreeNode* lowestCommonAncestor(TreeNode* root, TreeNode* p, TreeNode* q) {
if(!root || root == p || root == q) return root;
TreeNode* left = lowestCommonAncestor(root -> left, p, q);
TreeNode* right = lowestCommonAncestor(root -> right, p, q);
if(!left) return right;
if(!right) return left;
return root;
}

分割线

使用三个或更多的-或者*来创建分割线,例如:

1
2
---  
***


注脚

使用[^1]来创建注脚,例如:这是一段文本[^1]。注脚的内容用[^1]: 这是注脚1的内容并放置在文档的末尾。

1
2
3
4
这是一段文本[^1]。
...
...
[^1]: 这是注脚1的内容。
这是一个注脚示例 -> 1

数学公式

在线LaTeX公式编辑器:公式编辑器

行内显示: 使用$ $$ W_G^{mn}=max\{0,W_G.\xi_G(f_G^m,f_G^n)\} $
效果为\(W_G^{mn}=max\{0,W_G.\xi_G(f_G^m,f_G^n)\}\)

另起一行“ 使用$$ $$$$ W_G^{mn}=max\{0,W_G.\xi_G(f_G^m,f_G^n)\}$$效果如下:\[W_G^{mn}=max\{0,W_G.\xi_G(f_G^m,f_G^n)\}\]

若网页或插件支持Mathjax渲染,可以使用更多形式的公式。

简单公式

对于简单的公式,使用以下形式给出标签,如:

1
2
3
$$\begin{equation} \label{eq1}
a = b + c
\end{equation}$$
\[\begin{equation} \label{eq1} a = b + c \end{equation}\] 然后可以通过$\eqref{eq1}$引用公式,如:公式\(\eqref{eq1}\)表示了一个简单的公式。

多线公式

在公式内部,使用aligned将其分成多行,如:

1
2
3
4
5
6
7
$$\begin{equation} \label{eq2}
\begin{aligned}
a &= b + c \\
&= d + e + f + g \\
&= h + i
\end{aligned}
\end{equation}$$
\[\begin{equation} \label{eq2} \begin{aligned} a &= b + c \\ &= d + e + f + g \\ &= h + i \end{aligned} \end{equation}\]

多重对齐公式

在公式内部,使用align将其分成多行,并使用&进行对齐,如:

1
2
3
4
5
$$\begin{align}
a &= b + c \label{eq3} \\
x &= yz \label{eq4} \\
l &= m - n \label{eq5}
\end{align}$$
\[\begin{align} a &= b + c \label{eq3} \\ x &= yz \label{eq4} \\ l &= m - n \label{eq5} \end{align}\]

\[\widetilde{wwsd}\]

从编号中排除公式

align环境中,如果不想对某些公式进行编号,只需\nonumber在这些公式后面使用即可。就像下面这样

1
2
3
4
5
$$\begin{align}
-4 + 5x &= 2 + y \nonumber \\
w + 2 &= -1 + w \\
ab &= cb
\end{align}$$
\[\begin{align} -4 + 5x &= 2 + y \nonumber \\ w + 2 &= -1 + w \\ ab &= cb \end{align}\]

CSS样式

以下是一些CSS的样式示例

默认效果

primary效果

success效果

info效果

warning效果

danger效果

红色背景块

蓝色背景块

绿色背景块

黄色背景块

紫色背景块

这里输入文字

查看内容

图标网站

 下载内容

文本居中显示(适合摘要写作)

1
2
3
4
5
{%cq%}
To Be Or
Not To Be
That Is The Question
{%endcq%}

To Be Or
Not To Be
That Is The Question


  1. 这是注脚1的内容。↩︎