热门标签 | 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文档末尾需要一个空行结尾

技术分享图片


推荐阅读
  • Python 伦理黑客技术:深入探讨后门攻击(第三部分)
    在《Python 伦理黑客技术:深入探讨后门攻击(第三部分)》中,作者详细分析了后门攻击中的Socket问题。由于TCP协议基于流,难以确定消息批次的结束点,这给后门攻击的实现带来了挑战。为了解决这一问题,文章提出了一系列有效的技术方案,包括使用特定的分隔符和长度前缀,以确保数据包的准确传输和解析。这些方法不仅提高了攻击的隐蔽性和可靠性,还为安全研究人员提供了宝贵的参考。 ... [详细]
  • 如果应用程序经常播放密集、急促而又短暂的音效(如游戏音效)那么使用MediaPlayer显得有些不太适合了。因为MediaPlayer存在如下缺点:1)延时时间较长,且资源占用率高 ... [详细]
  • [转]doc,ppt,xls文件格式转PDF格式http:blog.csdn.netlee353086articledetails7920355确实好用。需要注意的是#import ... [详细]
  • javascript分页类支持页码格式
    前端时间因为项目需要,要对一个产品下所有的附属图片进行分页显示,没考虑ajax一张张请求,所以干脆一次性全部把图片out,然 ... [详细]
  • 在Cisco IOS XR系统中,存在提供服务的服务器和使用这些服务的客户端。本文深入探讨了进程与线程状态转换机制,分析了其在系统性能优化中的关键作用,并提出了改进措施,以提高系统的响应速度和资源利用率。通过详细研究状态转换的各个环节,本文为开发人员和系统管理员提供了实用的指导,旨在提升整体系统效率和稳定性。 ... [详细]
  • 本文介绍了如何在 ASP.NET 中设置 Excel 单元格格式为文本,获取多个单元格区域并作为表头,以及进行单元格合并、赋值、格式设置等操作。 ... [详细]
  • javax.mail.search.BodyTerm.matchPart()方法的使用及代码示例 ... [详细]
  • com.sun.javadoc.PackageDoc.exceptions()方法的使用及代码示例 ... [详细]
  • 本文介绍如何在 Android 中自定义加载对话框 CustomProgressDialog,包括自定义 View 类和 XML 布局文件的详细步骤。 ... [详细]
  • 网站访问全流程解析
    本文详细介绍了从用户在浏览器中输入一个域名(如www.yy.com)到页面完全展示的整个过程,包括DNS解析、TCP连接、请求响应等多个步骤。 ... [详细]
  • 解决Bootstrap DataTable Ajax请求重复问题
    在最近的一个项目中,我们使用了JQuery DataTable进行数据展示,虽然使用起来非常方便,但在测试过程中发现了一个问题:当查询条件改变时,有时查询结果的数据不正确。通过FireBug调试发现,点击搜索按钮时,会发送两次Ajax请求,一次是原条件的请求,一次是新条件的请求。 ... [详细]
  • 第二十五天接口、多态
    1.java是面向对象的语言。设计模式:接口接口类是从java里衍生出来的,不是python原生支持的主要用于继承里多继承抽象类是python原生支持的主要用于继承里的单继承但是接 ... [详细]
  • 秒建一个后台管理系统?用这5个开源免费的Java项目就够了
    秒建一个后台管理系统?用这5个开源免费的Java项目就够了 ... [详细]
  • Python 程序转换为 EXE 文件:详细解析 .py 脚本打包成独立可执行文件的方法与技巧
    在开发了几个简单的爬虫 Python 程序后,我决定将其封装成独立的可执行文件以便于分发和使用。为了实现这一目标,首先需要解决的是如何将 Python 脚本转换为 EXE 文件。在这个过程中,我选择了 Qt 作为 GUI 框架,因为之前对此并不熟悉,希望通过这个项目进一步学习和掌握 Qt 的基本用法。本文将详细介绍从 .py 脚本到 EXE 文件的整个过程,包括所需工具、具体步骤以及常见问题的解决方案。 ... [详细]
  • 在Android平台中,播放音频的采样率通常固定为44.1kHz,而录音的采样率则固定为8kHz。为了确保音频设备的正常工作,底层驱动必须预先设定这些固定的采样率。当上层应用提供的采样率与这些预设值不匹配时,需要通过重采样(resample)技术来调整采样率,以保证音频数据的正确处理和传输。本文将详细探讨FFMpeg在音频处理中的基础理论及重采样技术的应用。 ... [详细]
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社区 版权所有