Markdown 编写规范
时间:2022-07-26
本文章向大家介绍Markdown 编写规范,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。
==========================
说明
文档中使用的关键字「MUST」,「MUST NOT」,「REQUIRED」,「SHALL」,「SHALL NOT」,「SHOULD」,「SHOULD NOT」,「RECOMMENDED」,「MAY」和「OPTIONAL」在 RFC2119 中有说明。
规则
- 后缀必须「MUST」使用
.md
。 - 文件名必须「MUST」使用小写,多个单词之间使用
-
分隔。 - 文件编码必须「MUST」用 UTF-8。
- 文档标题应该「SHOULD」这样写。 Markdown 编写规范 ==========================
- 章节标题必须「MUST」以
##
开始,而不是#
。 - 章节标题必须「MUST」在
#
后加一个空格,且后面没有#
。 // bad ##章节1 // bad ## 章节1 ## // good ## 章节1 - 章节标题和内容间必须「MUST」有一个空行。 // bad ## 章节1 内容 ## 章节2 // good ## 章节1 内容 ## 章节2
- 代码段的必须「MUST」使用 Fenced code blocks 风格,如下所示: 1 console.log("");
- 表格的写法应该「SHOULD」参考 GFM,如下所示: 12345678910First Header | Second Header------------- | -------------Content Cell | Content CellContent Cell | Content Cell| Left-Aligned | Center Aligned | Right Aligned || :------------ |:---------------:| -----:|| col 3 is | some wordy text | 1600 || col 2 is | centered | 12 || zebra stripes | are neat |
- 中英文混排应该「SHOULD」采用如下规则:
- 英文和数字使用半角字符
- 中文文字之间不加空格
- 中文文字与英文、阿拉伯数字及 @ # $ % ^ & * . ( ) 等符号之间加空格
- 中文标点之间不加空格
- 中文标点与前后字符(无论全角或半角)之间不加空格
- 如果括号内有中文,则使用中文括号
- 如果括号中的内容全部都是英文,则使用半角英文括号
- 当半角符号 / 表示「或者」之意时,与前后的字符之间均不加空格
- 其它具体例子推荐阅读这里
- 中文符号应该「SHOULD」使用如下写法:
- 表达方式,应当「SHOULD」遵循《The Element of Style》:
- 使段落成为文章的单元:一个段落只表达一个主题
- 通常在每一段落开始要点题,在段落结尾要扣题
- 使用主动语态
- 陈述句中使用肯定说法
- 删除不必要的词
- 避免连续使用松散的句子
- 使用相同的结构表达并列的意思
- 将相关的词放在一起
- 在总结中,要用同一种时态(这里指英文中的时态,中文不适用,所以可以不理会)
- 将强调的词放在句末
扩展阅读
- Google 后来也出了 Markdown 规范,很多和这里是一样的,但也增加了一些约定,可以参考
Donate
- Url参数中出现+、空格、=、%、&、#等字符的解决办法
- 解决CSS垂直居中的几种方法(基于绝对定位,基于视口单位,Flexbox方法)
- Go语言学习之cgo(golang与C语言相互调用)
- golang之旅--数据类型之字符串
- Android保存图片到系统图库
- 基于Vue.js的大型报告页项目实现过程及问题总结(二)
- 使用Hexo搭建专属Blog
- Android项目中文字乱码问题
- golang中发送http请求的几种常见情况
- 注册中心 Eureka 源码解析 —— Eureka-Server 启动(一)之 ServerConfig
- lua表排序
- Go语言-base64使用
- Gitcafe绑定自定义域名
- 【死磕Java并发】—- J.U.C之并发工具类:CyclicBarrier
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法