Logo成贤计协指南

Markdown 语法

Markdown 语法的使用方法

该节由 BOBO 编写

创建你的第一个Markdown文件

  • 打开你选择的编辑器
  • 创建一个新文件
  • .md 为文件后缀

接下来你就可以在这个文件里自由编写啦☺️!

Markdown标题

Markdown 的标题编写有两种写法 (主播也是写教程查资料才发现的😂)

使用 # 进行标记 (推荐)

Markdown 使用 # 号来创建标题,这是从 HTML 的 <h1><h6> 标签概念演化而来的。

使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。

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

使用 =-标记一级和二级标题(基本不用

= 和 - 标记语法格式如下:

我展示的是一级标题
=================

我展示的是二级标题
-----------------

段落换行

段落的换行是使用两个以上空格加上回车

TODO: 待补充

字体

文本强调是写作中的重要技巧,Markdown 提供了简洁的方式来实现粗体和斜体效果。

Markdown 可以使用以下几种字体:粗体和斜体。

粗体用法: 使用两个星号 ** 或两个下划线 __ 包围文字:

这是**粗体文字**使用星号
这是__粗体文字__使用下划线

斜体语法: 使用一个星号 * 或一个下划线 _ 包围文字:

这是*斜体文字*使用星号
这是_斜体文字_使用下划线

粗斜体组合: 使用三个星号 *** 或三个下划线 ___

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

Tips

  • 推荐使用星号 * 而不是下划线 _,因为星号在各种 Markdown 解析器中兼容性更好
  • 不要过度使用强调,重点突出才有效果
  • 在中英文混合时,建议在强调符号前后加空格以提高可读性

分割线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

***

* * *

*****

- - -

----------

删除线

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

~~我是要被加删除线的内容~~

效果就是:我是要被加删除线的内容

下划线

Markdown 并没有特定的下划线的符号,但是我们可以使用HTML<u>来实现。(Markdown 可以使用部分 HTML 的语法)

<u>带下划线文本</u>

脚注

脚注是对文本的补充说明。

这是一段文本1

这是一段文本[^我是脚注]

[^我是脚注]: 我真是脚注

行内代码标记

行内代码用于在正文中标记代码片段、命令、变量名等:

基本语法

使用两个反引号 `` 包围代码

应用场景

  • 技术文档中的 API 名称、函数名
  • 配置文件中的参数名
  • 命令行指令
  • 标明键盘快捷键(如 Ctrl + C

高亮语法

文本高亮不是标准 Markdown 语法,但许多扩展支持:

常见语法:(需要一定的渲染支持)

这是==高亮部分==

HTML语法:

这是<mark>高亮部分</mark>

段落和换行

段落的创建方法

在 Markdown 中,段落是文本的基本单位,理解段落规则对于正确格式化文档至关重要。

段落基本规则

  • 段落由一个或多个连续的文本行组成
  • 段落之间由一个或多个空行分隔
  • 普通段落不应该用空格或制表符缩进

正确的段落写法

这是第一个段落。它可以包含多个句子,内容可以很长,会自动换行显示。

这是第二个段落。注意上面有一个空行分隔。

这是第三个段落。

格式风格 Tip

  • 在标题和内容之间留空行
  • 在列表前后留空行
  • 在代码块前后留空行
  • 保持一致的空行使用习惯

Markdown 列表

Markdown 支持有序列表无序列表

无序列表

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

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项


- 第一项
- 第二项
- 第三项

选择建议:

  • 在同一文档中保持一致的标记方式
  • 标记符号后必须有一个空格

有序列表

有序列表用于展示有顺序要求的步骤或项目。

有序列表使用数字并加上 . 号来表示,如:

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

冷知识 Markdown会自动修正

例如:

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

Markdown 会自动帮你变成连续的序号

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

当然我们也可以从指定数字开始:

5. 第五项
6. 第六项
7. 第七项

列表嵌套

列表嵌套技巧

列表可以嵌套使用,创建多层次的结构:

无序列表嵌套

- 水果
  - 苹果
    - 红苹果
    - 绿苹果
  - 香蕉
  - 橙子
- 蔬菜
  - 胡萝卜
  - 白菜

有序列表嵌套

1. 准备阶段
   2. 收集资料
   3. 制定计划
4. 执行阶段
   5. 开始实施
   6. 监控进度
7. 总结阶段

混合嵌套

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

任务列表(复选框列表)

任务列表是 GitHub 风格 Markdown 的扩展功能,现在被广泛支持:

基本语法

- [ ] 未完成的任务
- [x] 已完成的任务
- [ ] 另一个未完成的任务
  • 未完成的任务
  • 已完成的任务
  • 另一个未完成的任务

Tips

  • 方括号内的空格和 x 很重要:[ ][x]
  • 可以与嵌套列表结合使用
  • 在项目管理、学习计划、生活清单中特别有用
  • 某些编辑器支持点击复选框来切换状态

Markdown 引用块

引用块用于突出显示重要信息、引用他人观点或创建视觉层次。

单级引用的使用:

> 区块引用

我是引用

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

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

多级嵌套引用:

> 最外层
> > 第一层嵌套
> > > 第二层嵌套

最外层

第一层嵌套

第二层嵌套

当然在引用中可以使用上述的列表,也可以在列表中使用引用

Markdown代码块

Markdown 提供了多种方式来展示代码,从简单的行内代码到复杂的代码块,满足不同场景下的代码展示需求。

行内代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`),例如:

`printf()` 函数

常见用法示例:

  • 函数名:使用 console.log() 输出信息
  • 变量名:将值赋给 userName 变量
  • 命令行:运行 npm install 安装依赖
  • 键盘按键:按 Ctrl+C 复制内容
  • 文件名:编辑 index.html 文件

代码区块

你可以使用(```)包裹一段代码,并指定一种语言(也可以不指定,默认为 plaintext

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

常用语言标识符列表:

  • javascript / js - JavaScript
  • python / py - Python
  • html - HTML
  • css - CSS
  • sql - SQL
  • json - JSON
  • xml - XML
  • yaml / yml - YAML
  • bash / shell - Shell脚本
  • java - Java
  • cpp / c++ - C++
  • csharp / c# - C#
  • php - PHP
  • ruby / rb - Ruby
  • go - Go语言
  • rust - Rust
  • typescript / ts - TypeScript

Markdown 链接

链接是使 Markdown 文档具有交互性的关键元素。

掌握链接语法能让你创建内容丰富、易于导航的文档。

链接使用方法如下:

[链接名称](链接地址)
[链接文字](链接地址 "可选的标题")

或者

<链接地址>

实例:

[这是一个广告(其实是友链)](https://isbobo.cn/)

这是一个广告(其实是友链)

链接标题

连接标题的作用:

  • 当鼠标悬停在链接上时显示提示信息
  • 对搜索引擎优化和无障碍访问有帮助
  • 标题文字放在双引号、单引号或括号中都可以
[bobo的博客](https://isbobo.cn/ "这真是bobo的博客")

bobo的博客

参考式链接

参考式链接将链接定义与使用分离,让文档更整洁,特别适合长文档或需要多次引用相同链接的情况。

基本语法:

markdown[链接文字][参考标签]
[参考标签]: URL "可选标题"

这个链接用 1 作为网址变量 [Google][1]

<!-- 链接定义区域 -->
[1]: http://www.google.com/

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

参考链接的优势:

  • 文档正文更清爽,不被长 URL 打断
  • 便于链接的统一管理和更新
  • 相同链接可以重复使用,避免重复定义
  • 链接定义可以放在文档任意位置(通常放在末尾)

锚点链接的使用

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

跳转到标题:

# 目录
- [第一章:介绍](#第一章介绍)
- [第二章:安装](#第二章安装)
- [第三章:使用方法](#第三章使用方法)

# 第一章:介绍
这里是介绍内容...

# 第二章:安装
这里是安装说明...

# 第三章:使用方法
这里是使用说明...

锚点规则:

  • 标题会自动生成锚点
  • 锚点名称通常是标题的小写形式
  • 空格替换为连字符
  • 移除特殊字符

Markdown图片

图片能让文档更加生动和易于理解。 Markdown 的图片语法简洁而灵活。 Markdown 图片语法格式如下:

![替代文字](图片路径)
![替代文字](图片路径 "图片标题")
  • 开头一个感叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 'title' 属性的文字。

在这里的我的建议是使用相对路径,以便于项目的迁移。

Markdown表格

表格和引用是 Markdown 中重要的内容组织工具。 表格能够清晰地展示结构化数据,而引用则用于突出重要信息或引用他人观点。 Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。 语法格式如下:

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

语法要点

  • 表头和数据行之间必须有分隔线
  • 分隔线至少需要三个连字符 ---
  • 两端的竖线 | 是可选的,但建议保留以提高可读性
  • 不需要严格对齐,但对齐后更美观

对齐

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

  • ---: 设置内容和标题栏居右对齐。
  • :--- 设置内容和标题栏居左对齐。
  • :---: 设置内容和标题栏居中对齐。

Footnotes

  1. 我真是脚注