Markdown 教程

calendar_today 2025-02-06 10:00
edit_calendar 更新于: 2025-11-23 20:30

简介: Markdown是一种轻量级标记语言,2004年由 John Grub(约翰·格鲁伯)创建,编写的文档后缀名为 .md, .markdown 。Markdown能被用来写电子书、网站文档等,很多AI大模型也用Markdown语言来呈现文字。Markdown因其简洁性而经久不衰,它能让作者专注于写作而不是排版,同时也简单易学。

推荐使用 VSCode 。VSCode 默认集成了 Markdown 文档编辑插件,原生就支持高亮 Markdown 的语法。VSCode 实时预览还需要执行 Markdown: Open Preview to the Side 命令来实现。

标题

两种格式:

  1. 在标题文字下方至少写1个=表示一级标题,在标题文字下方写至少1个-表示二级标题。
  2. 使用#表示标题,一级标题对应1个#,二级标题对应2个#,以此类推。#后空格再输入标题文字。

段落

Markdown 段落没有特殊格式,直接编写文字。
段落换行:
在段落后使用1个空行。

字体

Markdown 仅支持以下几种字体:

语法 效果
*斜体文字* 斜体文字
_斜体文字_ 斜体文字
**粗体文字** 粗体文字
__粗体文字__ 粗体文字
***斜粗体文字*** 斜粗体文字
___斜粗体文字___ 斜粗体文字

分隔线、删除线、下划线

  1. 分隔线:你可以在一行中用三个以上的星号*、减号-、底线_来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。

  2. 删除线:如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线~~即可。

  3. 下划线:可通过HTML的<u>标签来实现。
    <u>带下划线文本</u>带下划线文本

脚注

对文字的补充说明。

正文[^要注明的文本]。
[^要注明的文本]:补充说明。

列表

无序列表
使用星号*、加号+或减号作为列表标记,后面再加一个空格,然后写内容。

* 第一项
+ 第二项
- 第三项
  • 第一项
  • 第二项
  • 第三项

有序列表
使用数字并加上.表示,不要忘了空格。

1. 第一项
2. 第二项
3. 第三项
  1. 第一项
  2. 第二项
  3. 第三项

提醒:列表可以嵌套,使用缩进。

区块

在段落开头使用>符号,再加上一个空格。
> 区块引用

区块引用

区块可嵌套。

> 外层
>> 中层
>>> 内层

外层

中层

内层

区块内可使用列表。
列表中可使用区块。

代码

片段
段落上的一个函数或片段的代码可以用反引号( ` )。

函数`printf()`

函数printf()

区块
可以用( ``` )包裹一段代码,并指定一种语言(也可以不指定)。

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

链接

  1. 我的[个人网站](https://zkytx.xyz)
    我的个人网站
  2. 直接使用链接地址<https://zkytx.xyz>
    直接使用链接地址https://zkytx.xyz
  3. 高级链接:通过展示在文档末尾的变量赋值来设置连接。
这个链接用 1 作为网址变量 [Qwen][1]
这个链接用 deepseek 作为网址变量 [DeepSeek][deepseek]
然后在文档的结尾为变量赋值(网址)
(空一行)
[1]: http://qwen.ai/
[deepseek]: https://www.deepseek.com/

这个链接用 1 作为网址变量 Qwen

这个链接用 deepseek 作为网址变量 DeepSeek

图片

![alt 属性文本](图片地址)![alt 属性文本](图片地址 "可选标题")

alt 属性文本

Markdown目前无法指定图片的高度和宽度,如有需要,可使用普通的<img>标签。

<img src="https://i1.hdslb.com/bfs/face/2b171bd35343fdbfbc579f9f286486ce682bc7f2.jpg@240w_240h_1c_1s_!web-avatar-nav.webp" width="20%">

表格

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

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

Markdown支持设置表格对齐方式:
:-左对齐
:-:居中对齐
-:右对齐

内嵌HTML标签

如:<kbd>Ctrl</kbd>Ctrl

转义

在markdown中,很多符号都被用来格式化文档了,但要想用原本的字符,就需要转义。
在字符前面添加反斜杠字符\
\*markdown→*markdown

公式

完善中…