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 两个版本整合到一起，也就是现在的版本。

四、按键使用 `<kbd></kbd>` 标签

以写 github 文档的时候，经常会遇到需要写按键的时候，为了突显它，可以使用 <kbd></kbd> 这个标签来突显，比如：

ctrl + v 粘贴
ctrl + x 剪切

ctrl + v 粘贴
ctrl + x 剪切

Markdown文档书写规范相关推荐

vue插件开发、文档书写、github发布、npm包发布一波流
做vue开发,基本的操作会了之后是不是特想撸一撸vue的插件,让自己的代码可(骚)复(骚)用(的).别急,今天和你一起手摸手,哦呸,是手把手,一起撸一管,哦再呸,是封装一个基于vue的支付宝密码弹窗插 ...
linux 如何查看终端格式,你应该还不知道，Linux终端下的 Markdown 文档查看器
原标题:你应该还不知道,Linux终端下的 Markdown 文档查看器现在,Markdown 差不多已经成为技术文档的标准.它可以实现技术文档的快捷写作,以及输出发布.同样都是标记语言,但Mark ...
C#解析Markdown文档，实现替换图片链接操作
前言又是好久没写博客了其实也不是没写,是最近在「做一个博客」,从2月21日开始,大概一个多星期的时间,疯狂刷进度,边写代码边写了一整系列的博客开发笔记,目前为止已经写了16篇了,然后上3月之后工作 ...
linux文档查看器翻译,mdv – Linux终端下的 Markdown 文档查看器
现在,Markdown 差不多已经成为技术文档的标准.它可以实现技术文档的快捷写作,以及输出发布.同样都是标记语言,但Markdown 文档相比HTML更加简单.一是体现在标记符的数量上,二是体现在标 ...
项目文档编写规范与代码规范
往往越是规模大的公司,其项目工作中的每一个环节都有相应的规范进行管理,这些规范都是都前辈呕心沥血,披荆斩棘所获的的经验总结,而非普通文书工作者的推猜可得. 当然,如果刚刚创业起步的小公司如能更早的抓住 ...
在HBuilder中编辑markdown文档(原)
最近才真正意识到markdown的神奇.本篇内容主要部分来自HBuilderX自带的markdown语法帮助,加入了一些自己认为很实用的使用方法. 目录自动生成目录返回目录生成html页面引 ...
MarkdownView：Markdown 文档预览视图组件
原文链接:https://github.com/keitaoouchi/MarkdownView MarkdownView:Markdown 文档预览视图组件.# 为开源点赞# -- 由SwiftLa ...
wiki文档书写格式
文档基本规范标题标题:标明需求的简短语句.或模块名称,目录是由标题生成,一份目录结构清晰的需求文档与标题的划分是密不可分. 正文正文:有规范格式和生效标志的正式文本,正文包括文字.表格.图片. ...
Atitit usrQBK1600 技术文档的规范标准化解决方案
Atitit usrQBK1600 技术文档的规范标准化解决方案 1.1. Keyword关键词..展关键词,横向拓展比较,纵向抽象细化拓展知识点1 1.2. 标题必须有高大上词汇,参考文章排行榜,1 ...

Markdown文档书写规范

MarkDown 文档书写规范

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

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

三、连行的文章如何换行

四、按键使用 `<kbd></kbd>` 标签

Markdown文档书写规范相关推荐

最新文章

热门文章

Markdown文档书写规范

MarkDown 文档书写规范

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

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

三、连行的文章如何换行

四、按键使用 <kbd></kbd> 标签

Markdown文档书写规范相关推荐

最新文章

热门文章

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

四、按键使用 `<kbd></kbd>` 标签