Markdown教程

本文来自 Markdown 教程

Markdown教程Markdown标题文本格式字体分割线脚注行内代码标记文本高亮段落和换行段落的基本规则强制换行技巧最佳实践建议列表无序列表有序列表列表嵌套无序列表嵌套:有序列表嵌套:混合嵌套嵌套规则任务列表使用技巧高级列表技巧引用块多级嵌套引用区块中使用列表列表中使用区块引用块内的其他元素包含标题包含列表包含代码包含链接和图片代码行内代码代码区块缩进式代码块三反引号代码块语言标识和语法高亮代码块的高级特性显示行号代码差异对比链接锚点链接图片图片alt文本图片尺寸控制链接和图片的高级用法图片链接组合相对路径与绝对路径图片居中对齐方法一:HTML+CSS方法二:使用HTML对齐属性方法三:创建图片画廊性能优化建议常见问题表格对齐方式复杂表格元格内容格式化处理长文本换行处理缩写和链接表格中的特殊字符表格美化建议使用Emoji和符号数据表格最佳实践财务数据表格技术对比表格响应式表格处理高级技巧支持的HTML元素转义公式流程图、时序图、甘特图横向流程图竖向流程图标准流程图源码格式标准流程图源码格式(横向)UML时序图源码样例UML时序图源码复杂样例UML标准时序图样例甘特图样例分割线水平分割线数学公式基本语法结构常用LaTeX命令多行公式常用数学符号基本运算符号比较符号集合符号希腊字母特殊函数和符号矩阵图表绘制流程图时序图和甘特图时序图甘特图饼图

Markdown标题

使用井号 # 号创建标题

一个#号为一级标题、两个#为二级标题,共六级。

井号必须在行首,且若干个井号后面必须跟一个空格:

推荐的标题层次结构应该遵循逻辑顺序,而不应该跳级使用:

 

文本格式

字体

推荐使用星号,下划线在各种Markdown解析器中可能会引起误解,且下划线不易分辨个数。

建议在强调符号前后添加空格以提高可读性。

分割线

三个以上星号(*)或减号(-)或下划线(_)可以创建一个分割线。

分割线的行内不能有其他字符。

脚注

使用 [^文字] 设置[^脚注]

使用<sub>和</sub>设置 下角标

使用<sup>和</sup>设置 上角标

行内代码标记

使用反引号包围 代码

当代码内包含反引号时,使用两个反引号`包围`

应用场景:

文本高亮

文本高亮不是标准的Markdown语法,有些平台支持【前后各两个等号包围的文字,会以 == 高亮 == 显示】。

HTML替代方案是以 <mark> 和 </mark> 将需要 高亮的文本 包围起来。

段落和换行

段落的基本规则

强制换行技巧

最佳实践建议

列表

无序列表

无序列表使用星号(*)、加号(+)、或减号(-)作为列表标记,在这些标记后面添加一个 空格 ,然后填写内容。例如:

建议:

有序列表

使用数字加上英文句号作为列表标记,在标记后面添加一个 空格 ,然后填写内容。例如:

数字可以不连续,例如:

也可以从指定数字开始:

列表嵌套

可以创建多层次的结构。

无序列表嵌套:

有序列表嵌套:

  1. 准备阶段

    1. 收集资料
    2. 制定计划
  2. 执行阶段

    1. 开始实施
    2. 监控进度
  3. 总结阶段

混合嵌套

  1. 主要任务

    • 子任务A

    • 子任务B

      1. 详细步骤1
      2. 详细步骤2
    • 子任务C

  2. 次要任务

列表混合嵌套只需在子列表中的选项前面添加两个或四个空格即可:

  1. 第一项:

    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项:

    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

嵌套规则

任务列表

任务列表是GitHub风格的Markdown扩展功能:

实例:

显示效果如下:

01

使用技巧

高级列表技巧

若列表项包含多段,可以在第二段头部使用回退键消除掉自动生成的列表标记。

可以在列表项中使用引用。

引用块

在段落开头使用 > 符号,然后紧跟一个 空格 ,例如:

区块引用 菜鸟教程 学的不仅是技术更是梦想

对于多行引用,也可以用如下写法:

这是一个长引用, 包含多行内容, 只需要在第一行使用 > 符号。

多级嵌套引用

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

最外层

第一层嵌套

第二层嵌套

区块中使用列表

区块中使用列表

  1. 第一项
  2. 第二项

列表中使用区块

引用块内的其他元素

引用块内可以包含几乎所有其他Markdown元素。

包含标题

重要提醒

请在操作前仔细阅读文档,避免数据丢失。

包含列表

注意事项

  1. 备份重要数据
  2. 检查系统兼容性
  3. 准备回滚方案

包含代码

要运行这个脚本,请使用以下命令:

执行后会在 http://localhost:3000 看到结果。

包含链接和图片

📚 推荐阅读

详细信息请参考 官方文档

示例图片

&#x 后面跟的是十六进制数表示的Unicode表情符号(可在 Emoji Unicode Tables 中查找)。

代号含义
&#x2705
&#x26a0
&#xfe0f (可能是个空格)
&#x274c
&#x2139
&#x1f4da📚

代码

行内代码

反引号包围的代码片段,例如:

printf() 函数

使用 `反引号` 包围代码

包含 `` 双反引号的代码

其他特殊字符处理:

代码区块

缩进式代码块

【此方法在Typora内似乎不支持】

代码区块使用4个空格或者一个制表符。

正常文本段落

继续正常文本

三反引号代码块

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

若指定语言,支持语法高亮:

语言标识和语法高亮

在三反引号后添加语言标识符可以启用语法高亮功能。常用的语言标识符列表:

代码块的高级特性

显示行号

某些Markdown渲染器支持显示行号,通过特定的语法或配置实现。

或者:

【Typora不支持】

代码差异对比

链接

链接语法如下:

或者:

示例:

这是一个链接 菜鸟教程

https://www.runoob.com

邮箱链接:

markdown联系我:发送邮件 电话联系:拨打电话

锚点链接

锚点链接用于在同一个文档内跳转,适合长文档的导航。

跳转到标题:

手动创建锚点:

【似乎没用】

图片

图片语法格式如下:

建议:

也可以像网址那样对图片网址使用变量:

Markdown无法指定图片的高度和宽度,只能用 <img> 标签来解决:

建议本地备份重要图片

图片alt文本

alt文本(替代文字)在图片无法显示时提供替代信息。

图片尺寸控制

使用HTLM img标签:

响应式图片:

图片对齐:

链接和图片的高级用法

图片链接组合

将图片作为链接的可点击元素:

相对路径与绝对路径

相对路径的优势:

建议:

图片居中对齐

方法一:HTML+CSS
方法二:使用HTML对齐属性
方法三:创建图片画廊

示例:

性能优化建议

常见问题

表格

表格语法格式如下:

表头表头
单元格单元格
单元格单元格

语法要点:

对齐方式

示例:

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

复杂表格

元格内容格式化

语法:

功能描述状态
用户登录支持邮箱和手机号登录
密码重置通过邮箱重置密码⚠️
API接口RESTful API 设计
文档链接查看详细文档📖

处理长文本

换行处理
项目详细说明
需求分析1. 收集用户需求
2. 分析业务场景
3. 确定功能范围
技术选型前端:React + TypeScript
后端:Node.js + Express
数据库:MongoDB
缩写和链接
技术栈说明官网
React用户界面库链接
Vue.js渐进式框架链接
Angular完整的框架链接

表格中的特殊字符

某些字符在表格中有特殊含义,需要转义:

字符转义方法示例
竖线\|显示 | 符号
反斜杠\\显示 \ 符号
HTML直接使用<div>

表格美化建议

使用Emoji和符号
状态图标说明
完成任务已完成
进行中🔄正在处理
待处理等待开始
错误出现问题
警告⚠️需要注意
数据表格最佳实践
财务数据表格
月份收入支出利润增长率
1月¥50,000¥35,000¥15,000-
2月¥55,000¥38,000¥17,000+13.3%
3月¥62,000¥42,000¥20,000+17.6%
总计¥167,000¥115,000¥52,000+31.1%
技术对比表格
特性ReactVue.jsAngular评分
学习曲线中等简单复杂Vue ⭐⭐⭐
性能表现优秀优秀良好平分 ⭐⭐⭐
生态系统丰富成长中完整React ⭐⭐⭐
企业支持Facebook社区GoogleAngular ⭐⭐⭐
响应式表格处理

对于复杂的表格,可以考虑分解成多个简单表格。

移动端友好的设计:

项目
姓名张三
年龄25
职业工程师
类型信息
邮箱zhang@example.com
电话138-0013-8000
地址北京市朝阳区

高级技巧

支持的HTML元素

不在Markdown涵盖范围内的标签,都可以直接在文档中用HTML撰写。

目前支持的HTML元素有: <kbd> 、 <b> 、<i> 、<em> 、<sup> 、<sub> 、<br> 等。

使用 Ctrl+Alt+Del 重启电脑

转义

Markdown使用反斜杠转义特殊字符(或特殊位置的特殊字符):

文本加粗 ** 正常显示星号 **

Markdown支持以下符号的转义:

公式

Markdown Preview Enhanced 使用 KaTeX 或者 MathJax 来渲染数学表达式。

KaTeX比MathJax更快,但特性较少。

默认分隔符:

流程图、时序图、甘特图

横向流程图

a=1
a=2
方形
圆角
条件a
结果1
结果2
横向流程图

竖向流程图

a=1
a=2
方形
圆角
条件a
结果1
结果2
竖向流程图

标准流程图源码格式

Created with Raphaël 2.2.0开始框处理框判断框(是或否?)输入输出框结束框子流程yesno

标准流程图源码格式(横向)

Created with Raphaël 2.2.0开始框处理框判断框(是或否?)输入输出框结束框子流程yesno

UML时序图源码样例

Created with Raphaël 2.2.0对象A对象A对象B对象B对象B你好吗?(请求)对象B的描述对象A的描述(提示)我很好(响应)你真的好吗?

UML时序图源码复杂样例

Created with Raphaël 2.2.0标题:复杂使用对象A对象A对象B对象B小三小三CC对象B你好吗?(请求)对象B的描述对象A的描述(提示)我很好(响应)你好吗对象B找我了你真的好吗?我们是朋友没人陪我玩

UML标准时序图样例

张三李四王五王五你好吗?与疾病战斗loop[健康检查]合理 食物 看医生...很好!你怎么样?很好!张三李四王五

甘特图样例

2014-01-072014-01-092014-01-112014-01-132014-01-152014-01-172014-01-192014-01-212014-01-23需求 学习准备理解需求 原型 UI设计 设计框架 开发 未来任务 未来任务 功能测试 压力测试 测试报告 设计开发测试软件开发甘特图

分割线

水平分割线

Markdown支持三种分割线:

  1. 使用三个连字符

  2. 使用三个星号

  3. 使用三个下划线

可以使用更多的符号,但最少三个;符号之间可以有空格

避免使用过度。

数学公式

在Markdown中,数学公式通过LaTeX语法来显示。

基本语法结构

常用LaTeX命令

【Typora不支持行内公式】

块级公式以$$开头,Typora会自动补齐尾部的$$,并生成公式块。

多行公式

使用align环境创建多行对齐公式:

常用数学符号

基本运算符号

比较符号

集合符号

希腊字母

常用希腊字母及其LaTeX表示:

字母代码字母代码
AAα\alhpa
BBβ\beta
Γ\Gammaγ\gamma
Δ\Deltaδ\delta
EEϵ\epsilon
ZZζ\zeta
HHη\eta
Θ\Thetaθ\theta
IIι\iota
KKκ\kappa
Λ\Lambdaλ\lambda
MMμ\mu
NNν\nu
Ξ\Xiξ\xi
OOο\omicron
Π\Piπ\pi
PPρ\rho
Σ\Sigmaσ\sigma
TTτ\tau
Υ\Upsilonυ\upsilon
Φ\Phiϕ\phi
XXχ\chi
Ψ\Psiψ\psi
Ω\vω\omega

特殊函数和符号

矩阵

使用matrix环境:

不同括号类型的矩阵:

图表绘制

Mermaid是Markdown中最流行的图表工具之一。

支持的图表类型:

流程图

Yes
No
开始
条件判断
执行操作A
执行操作B
结束

流程图方向:

节点形状:

连接线类型:

时序图和甘特图

时序图

用户系统数据库登录请求验证用户信息返回验证结果登录成功/失败用户系统数据库

时序图语法要点:

甘特图

2024-01-072024-01-142024-01-212024-01-282024-02-042024-02-112024-02-182024-02-252024-03-032024-03-102024-03-172024-03-242024-03-312024-04-07需求分析 UI设计 后端开发 前端开发 单元测试 集成测试 设计阶段开发阶段测试阶段项目开发计划

甘特图语法要点:

饼图

65%15%10%10%浏览器市场份额ChromeSafariFirefox其他