Markdownlint 使用教程

Markdownlint 使用教程

markdownlintMarkdown lint tool项目地址:https://gitcode.com/gh_mirrors/mar/markdownlint

1. 目录结构及介绍

Markdownlint 的源代码仓库通常具有以下基本目录结构：

markdownlint/
├── lib/          # 存放核心规则实现
│   ├── *.js      # 各个规则的JavaScript文件
├── test/         # 测试案例和测试脚本
│   ├── fixtures/ # 示例Markdown文件
│   └── *.js      # 自动化测试脚本
├── bin/          # 包含命令行工具入口文件
│   └── markdownlint.js
├── README.md     # 项目说明
└── package.json  # 项目依赖和元数据

• lib/: 存储用于检查Markdown文件的规则的JavaScript代码。
• test/: 包括测试案例和自动化测试用例，确保规则的正确性。
• bin/: 提供了可执行文件markdownlint.js，它是Markdownlint命令行界面的入口点。
• README.md: 项目的基本介绍和使用指南。
• package.json: 定义项目依赖和配置信息。

2. 项目的启动文件介绍

Markdownlint 的启动文件是位于bin/markdownlint.js。这个文件是一个Node.js脚本，它接收命令行参数并调用Markdownlint的核心功能来检查指定的Markdown文件。当你在命令行中运行npx markdownlint或全局安装后的markdownlint时，实际上是执行这个脚本。

# 在项目根目录下运行
$ npx markdownlint path/to/file.md

或

# 全局安装后运行
$ markdownlint path/to/file.md

该脚本处理输入参数，解析配置文件（如果有），然后遍历指定的Markdown文件，应用所有的Markdownlint规则进行检查。

3. 项目的配置文件介绍

Markdownlint 支持通过.markdownlintrc、.markdownlint.json或markdownlint.config.js等不同类型的配置文件来定制规则。配置文件可以定义哪些规则开启或关闭，以及某些规则的特定选项。

一个简单的示例配置文件可能如下所示：

{
  "MD001": { // 规则ID
    "level": "error",  // 设置为错误级别
    "headers": ["h1", "h2"] // 只对h1和h2标题检查
  },
  "MD003": {
    "style": "atx"  // 强制使用ATX风格的标题
  }
}

此外，你还可以在命令行中临时覆盖配置文件中的设置，例如：

# 关闭MD001规则
$ markdownlint --no-MD001 path/to/file.md

或者通过--config选项指定不同的配置文件：

# 使用指定路径的配置文件
$ markdownlint --config config.json path/to/file.md

请注意，Markdownlint 也支持使用CommonJS模块形式的配置文件，如markdownlint.config.js，其中导出一个对象：

module.exports = {
  "rules": {
    "MD001": {
      "level": "error",
      "headers": ["h1", "h2"]
    },
    "MD003": {
      "style": "atx"
    }
  }
};

了解这些基础知识后，你可以更深入地探索Markdownlint的规则集和如何根据项目需求自定义其行为。祝你在Markdown代码规范之路上一帆风顺！

markdownlintMarkdown lint tool项目地址:https://gitcode.com/gh_mirrors/mar/markdownlint