Markdown文档书写规范

十月ooOO

已于 2023-06-15 12:30:07 修改

阅读量1k

点赞数

CC 4.0 BY-SA版权

分类专栏： markdown 文章标签： markdown md

于 2023-06-15 12:14:31 首次发布

本文链接：https://blog.csdn.net/KimBing/article/details/131224377

markdown 专栏收录该内容

1 篇文章

订阅专栏

本文介绍了Markdown文档的书写规范，包括主目录添加序号以提高阅读性，英文和数字前后添加空格以提升可读性，如何正确进行换行，以及使用`<kbd>`标签表示按键操作。这些规范对于编写README.md文件和博客特别有用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

MarkDown 文档书写规范

MarkDown 越来越成为方便快捷有效的文档书写格式。尤其对开发者来说。

主要有两个地方用到：

项目的 README.md 文件是每个项目都应该有的一个项目说明文档，里面介绍了项目的基础信息，和需要注意的地方。
写博客的时候，技术的或者生活的

但发现大多数人的书写还是非常不标准的。所以介绍一下写 MarkDown 需要注意的地方和规范，这里不介绍语法，只介绍规范。

一、主目录添加序号更易阅读

就拿我这篇文章举例，如果不添加序号，读者在深入某个标题的内容之后就不知道自己所处的文章位置。

## 主目录添加序号更易阅读
## 英文和数字前后应该添加空格
## 连行的文章如何换行
## 按键使用 `<kbd></kbd>` 标签

## 一、主目录添加序号更易阅读
## 二、英文和数字前后应该添加空格
## 三、连行的文章如何换行
## 四、按键使用 `<kbd></kbd>` 标签

二、英文和数字前后应该添加空格

在英文和数字前后添加空格会让文章更易阅读。
比如以下这段话，在英文和数字前后添加空格是这种效果

2017 年的时候想学 iOS 了顺便做了个不太成熟的 iOS 版 app，当时日记是存储在 iCloud 中的，有了 app 的界面样子，但并不能很完美的使用。
后来过了很久，到 2019 年的时候感觉自己前端技术差不多了，就想把它实现了，最初使用的是 HTML + jQuery。
后来对 Vue 了解的足够多之后，就改成了 HTML + Vue。最初只有移动端的，添加了 PC 版界面。
再后来就大改了，改成了纯 Vue 模式，此时的 PC 版和移动端还是在两个分支上的。
又过了好久，移动端和 PC 两个版本整合到一起，也就是现在的版本。

如果去掉空格，就会感觉很难受

2017年的时候想学iOS了顺便做了个不太成熟的iOS版app，当时日记是存储在iCloud中的，有了app的界面样子，但并不能很完美的使用。
后来过了很久，到2019年的时候感觉自己前端技术差不多了，就想把它实现了，最初使用的是HTML+jQuery。
后来对Vue了解的足够多之后，就改成了HTML+Vue。最初只有移动端的，添加了PC版界面。
再后来就大改了，改成了纯Vue模式，此时的PC版和移动端还是在两个分支上的。
又过了好久，移动端和PC两个版本整合到一起，也就是现在的版本。

三、连行的文章如何换行

还是上面那段话举例，这是 markdown 文档的样子

2017 年的时候想学 `iOS` 了顺便做了个不太成熟的 `iOS` 版 `app`，当时日记是存储在 `iCloud` 中的，有了 `app` 的界面样子，但并不能很完美的使用。
后来过了很久，到 2019 年的时候感觉自己前端技术差不多了，就想把它实现了，最初使用的是 `HTML` + `jQuery`。
后来对 `Vue` 了解的足够多之后，就改成了 `HTML` + `Vue`。最初只有移动端的，添加了 PC 版界面。
再后来就大改了，改成了纯 `Vue` 模式，此时的 PC 版和移动端还是在两个分支上的。
又过了好久，移动端和 PC 两个版本整合到一起，也就是现在的版本。

渲染出来是这样的

2017 年的时候想学 iOS 了顺便做了个不太成熟的 iOS 版 app，当时日记是存储在 iCloud 中的，有了 app 的界面样子，但并不能很完美的使用。后来过了很久，到 2019 年的时候感觉自己前端技术差不多了，就想把它实现了，最初使用的是 HTML + jQuery。后来对 Vue 了解的足够多之后，就改成了 HTML + Vue。最初只有移动端的，添加了 PC 版界面。再后来就大改了，改成了纯 Vue 模式，此时的 PC 版和移动端还是在两个分支上的。又过了好久，移动端和 PC 两个版本整合到一起，也就是现在的版本。

如果想让它换行，需要在每行后面添加【两个空格】

换段的话，需要在每行中间添加空行。

它在每行后面添加两个空格后才是正常显示的样子：

2017 年的时候想学 iOS 了顺便做了个不太成熟的 iOS 版 app，当时日记是存储在 iCloud 中的，有了 app 的界面样子，但并不能很完美的使用。
后来过了很久，到 2019 年的时候感觉自己前端技术差不多了，就想把它实现了，最初使用的是 HTML + jQuery。
后来对 Vue 了解的足够多之后，就改成了 HTML + Vue。最初只有移动端的，添加了 PC 版界面。
再后来就大改了，改成了纯 Vue 模式，此时的 PC 版和移动端还是在两个分支上的。
又过了好久，移动端和 PC 两个版本整合到一起，也就是现在的版本。