热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

【Markdownlint】让我们的Markdown不一样

前言Markdownlint是一款非常好用的Markdown格式检查工具,它规定了许多Markdown规则并实时对文档进行检查,防止一些语法错误,维持文档风格的统一,使用此工具有助

前言

??Markdownlint是一款非常好用的 Markdown 格式检查工具,它规定了许多Markdown规则并实时对文档进行检查,防止一些语法错误,维持文档风格的统一,使用此工具有助于形成一个良好的写作习惯和规范。


Markdownlint规范



































































































































































































































代码描述解释
MD001Heading levels should only increment by one level at a time标题级数只能每次扩大一个,也就是说不能隔级创建标题,必须h1-h2-h3...这样
MD002First heading should be a top level heading文档的第一个标题必须是最高级的标题
MD003Heading style整篇文档的标题格式要统一
MD004Unordered list style整篇文档的无序列表的格式要一致
MD005Inconsistent indentation for list items at the same level同一个等级的列表的缩进要一致
MD006Consider starting bulleted lists at the beginning of the line一级标题不能够缩进
MD007Unordered list indentation无序列表嵌套的时候默认采取两个空格的缩进方式
MD009Trailing spaces行尾最多可以添加两个空格,超出之后会有警告,最好每次都是两个空格因为两个空格刚好可以用来换行
MD010Hard tabs不能使用tab来进行缩进,要使用空格
MD011Reversed link syntax内联形式的链接和创建方式是否错误,中括号和圆括号是否使用正确
MD012Multiple consecutive blank lines文档中不能有连续的空行(文档末可以有一个空行),在代码块中这个规则不会生效
MD013Line length默认行的最大长度是80,对表格代码块标题都起效果
MD014Dollar signs used before commands without showing output在代码块中,终端命令前面不需要有美元符号,如果如果代码块中既有终端命令,也有命令的输出,则终端命令前可以有美元符号($)
MD018No space after hash on atx style heading标题格式如果是"atx"的话,#号和文字之间需要一个空格隔开
MD019Multiple spaces after hash on atx style heading标题格式如果是"atx"的话,#号和文字之间只需要一个空格隔开,不需要多个
MD020No space inside hashes on closed atx style heading在closed_atx格式的标题中,文字和前后的#号之间都需要一个空格隔开
MD021Multiple spaces inside hashes on closed atx style heading在closed_atx格式的标题中,文字和前后的#号之间只需要一个空格隔开,不能有多余的
MD022Headings should be surrounded by blank lines标题的上下行必须都是空格
MD023Headings must start at the beginning of the line标题行不能缩进
MD024Multiple headings with the same content在文档中不能有重复性的标题
MD025Multiple top level headings in the same document同一个文档中,只能有一个最高级的标题,默认也只能有一个一级标题
MD026Trailing punctuation in heading标题的末尾不能有". , ; : ! ? "这些符号
MD027Multiple spaces after blockquote symbol在创建引用块的时候,右尖号与文字之间必须有且只有一个空格
MD028Blank line inside blockquote两个引用区块间不能仅用一个空行隔开或者同一引用区块中不能有空行,如果一行中没有内容,则这一行要用>开头
MD029Ordered list item prefix有序列表的前缀序号格式必须只用1或者从1开始的加1递增数字
MD030Spaces after list markers列表(有序、无序)的前缀符号和文字之间用1个空格隔开,在列表嵌套或者同一列表项中有多个段落时,无序列表缩进两个空格,有序列表缩进3个空格
MD031Fenced code blocks should be surrounded by blank lines单独的代码块前后需要用空行隔开(除非是在文档开头或末尾),否则有些解释器不会解释为代码块
MD032Lists should be surrounded by blank lines列表(有序、无序)前后需要用空行隔开,否则有些解释器不会解释为列表,列表的缩进必须一致,否则会警告
MD033Inline HTML文档中不允许使用html语句
MD034Bare URL used单纯的链接地址需要用尖括号 (<>) 包裹,否则有些解释器不会解释为链接
MD035Horizontal rule style创建水平线时整篇文档要统一,要和文档中第一次创建水平线使用的符号一致
MD036Emphasis used instead of a heading不能用强调来代替标题 ****
MD037Spaces inside emphasis markers强调的符号和文字之间不能有空格
MD038Spaces inside code span elements当用单反引号创建代码段的时候,单反引号和它们之间的代码不能有空格,如果要把单反引号嵌入到代码段的首尾,创建代码段的单反引号和嵌入的单反引号间要有一个空格隔开
MD039Spaces inside link text链接名和包围它的中括号之间不能有空格,但链接名中间可以有空格
MD040Fenced code blocks should have a language specified单独的代码块(此处是指上下用三个反引号包围的代码块)应该指定代码块的编程语言,这一点有助于解释器对代码进行代码高亮
MD041First line in file should be a top level heading文档的第一个非空行应该是文档最高级的标题,默认是1级标题
MD042No empty links链接的地址不能为空
MD043Required heading structure要求标题遵循一定的结构,默认是没有规定的结构
MD044Proper names should have the correct capitalization指定一些名称,会检查它是否有正确的大写
MD045Images should have alternate text (alt text)图片链接必须包含描述文本
MD046Code block style整篇文档采用一致的代码格式
MD047Files should end with a single newline character文档末尾需要一个空行结尾

技术分享图片


推荐阅读
  • HDU 2372 El Dorado(DP)的最长上升子序列长度求解方法
    本文介绍了解决HDU 2372 El Dorado问题的一种动态规划方法,通过循环k的方式求解最长上升子序列的长度。具体实现过程包括初始化dp数组、读取数列、计算最长上升子序列长度等步骤。 ... [详细]
  • 本文讨论了如何优化解决hdu 1003 java题目的动态规划方法,通过分析加法规则和最大和的性质,提出了一种优化的思路。具体方法是,当从1加到n为负时,即sum(1,n)sum(n,s),可以继续加法计算。同时,还考虑了两种特殊情况:都是负数的情况和有0的情况。最后,通过使用Scanner类来获取输入数据。 ... [详细]
  • 本文介绍了OC学习笔记中的@property和@synthesize,包括属性的定义和合成的使用方法。通过示例代码详细讲解了@property和@synthesize的作用和用法。 ... [详细]
  • 1,关于死锁的理解死锁,我们可以简单的理解为是两个线程同时使用同一资源,两个线程又得不到相应的资源而造成永无相互等待的情况。 2,模拟死锁背景介绍:我们创建一个朋友 ... [详细]
  • 《数据结构》学习笔记3——串匹配算法性能评估
    本文主要讨论串匹配算法的性能评估,包括模式匹配、字符种类数量、算法复杂度等内容。通过借助C++中的头文件和库,可以实现对串的匹配操作。其中蛮力算法的复杂度为O(m*n),通过随机取出长度为m的子串作为模式P,在文本T中进行匹配,统计平均复杂度。对于成功和失败的匹配分别进行测试,分析其平均复杂度。详情请参考相关学习资源。 ... [详细]
  • 动态规划算法的基本步骤及最长递增子序列问题详解
    本文详细介绍了动态规划算法的基本步骤,包括划分阶段、选择状态、决策和状态转移方程,并以最长递增子序列问题为例进行了详细解析。动态规划算法的有效性依赖于问题本身所具有的最优子结构性质和子问题重叠性质。通过将子问题的解保存在一个表中,在以后尽可能多地利用这些子问题的解,从而提高算法的效率。 ... [详细]
  • 高质量SQL书写的30条建议
    本文提供了30条关于优化SQL的建议,包括避免使用select *,使用具体字段,以及使用limit 1等。这些建议是基于实际开发经验总结出来的,旨在帮助读者优化SQL查询。 ... [详细]
  • 本文内容为asp.net微信公众平台开发的目录汇总,包括数据库设计、多层架构框架搭建和入口实现、微信消息封装及反射赋值、关注事件、用户记录、回复文本消息、图文消息、服务搭建(接入)、自定义菜单等。同时提供了示例代码和相关的后台管理功能。内容涵盖了多个方面,适合综合运用。 ... [详细]
  • 本文介绍了lua语言中闭包的特性及其在模式匹配、日期处理、编译和模块化等方面的应用。lua中的闭包是严格遵循词法定界的第一类值,函数可以作为变量自由传递,也可以作为参数传递给其他函数。这些特性使得lua语言具有极大的灵活性,为程序开发带来了便利。 ... [详细]
  • 基于layUI的图片上传前预览功能的2种实现方式
    本文介绍了基于layUI的图片上传前预览功能的两种实现方式:一种是使用blob+FileReader,另一种是使用layUI自带的参数。通过选择文件后点击文件名,在页面中间弹窗内预览图片。其中,layUI自带的参数实现了图片预览功能。该功能依赖于layUI的上传模块,并使用了blob和FileReader来读取本地文件并获取图像的base64编码。点击文件名时会执行See()函数。摘要长度为169字。 ... [详细]
  • 本文介绍了使用Java实现大数乘法的分治算法,包括输入数据的处理、普通大数乘法的结果和Karatsuba大数乘法的结果。通过改变long类型可以适应不同范围的大数乘法计算。 ... [详细]
  • 本文讲述了作者通过点火测试男友的性格和承受能力,以考验婚姻问题。作者故意不安慰男友并再次点火,观察他的反应。这个行为是善意的玩人,旨在了解男友的性格和避免婚姻问题。 ... [详细]
  • 本文详细介绍了Linux中进程控制块PCBtask_struct结构体的结构和作用,包括进程状态、进程号、待处理信号、进程地址空间、调度标志、锁深度、基本时间片、调度策略以及内存管理信息等方面的内容。阅读本文可以更加深入地了解Linux进程管理的原理和机制。 ... [详细]
  • Java验证码——kaptcha的使用配置及样式
    本文介绍了如何使用kaptcha库来实现Java验证码的配置和样式设置,包括pom.xml的依赖配置和web.xml中servlet的配置。 ... [详细]
  • 本文介绍了指针的概念以及在函数调用时使用指针作为参数的情况。指针存放的是变量的地址,通过指针可以修改指针所指的变量的值。然而,如果想要修改指针的指向,就需要使用指针的引用。文章还通过一个简单的示例代码解释了指针的引用的使用方法,并思考了在修改指针的指向后,取指针的输出结果。 ... [详细]
author-avatar
手机用户2502905797
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有