MarkdownLint-CLI2 使用教程

MarkdownLint-CLI2 使用教程

markdownlint-cli2 A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the markdownlint library 项目地址: https://gitcode.com/gh_mirrors/ma/markdownlint-cli2

1. 项目介绍

MarkdownLint-CLI2 是一个快速的、基于配置的命令行界面，用于使用 markdownlint 库对 Markdown/CommonMark 文件进行校验。它旨在简化配置过程，并优先考虑速度和易用性，同时支持 markdownlint-cli 的所有特性，但在某些情况下会有所不同。

2. 项目快速启动

首先，确保您的系统中已经安装了 Node.js。

安装

作为全局命令行工具：

npm install markdownlint-cli2 --global

或者，作为当前 Node.js 包的开发依赖：

npm install markdownlint-cli2 --save-dev

使用 Docker 容器

您也可以使用 Docker 容器来运行 MarkdownLint-CLI2：

docker pull davidanson/markdownlint-cli2

使用 Homebrew (仅限 macOS)

brew install markdownlint-cli2

使用 GitHub Action

在您的 GitHub Actions 工作流中添加以下步骤：

- name: markdownlint-cli2-action
  uses: DavidAnson/markdownlint-cli2-action@v9

命令行使用

使用以下命令来校验 Markdown 文件：

markdownlint-cli2 glob0 [glob1] [...] [globN] [--config file] [--fix] [--help]

• glob0 [glob1] [...] [globN]：指定需要校验的文件模式。
• --config file：指定配置文件的路径。
• --fix：更新文件以解决可修复的问题。
• --help：显示帮助信息。

请注意，为了跨平台兼容性，建议在 shell 中引用参数时使用双引号。

3. 应用案例和最佳实践

以下是一些使用 MarkdownLint-CLI2 的案例：

校验当前目录下的所有 Markdown 文件

markdownlint-cli2 ./*.md

校验子目录中的 Markdown 文件

markdownlint-cli2 **/*.md

校验并修复 Markdown 文件

markdownlint-cli2 --fix ./*.md

使用配置文件

在项目根目录下创建一个配置文件 .markdownlint-cli2.jsonc，该文件可以定义您的校验规则和排除模式。

{
  "globs": ["*.md", "!node_modules"],
  "rules": {
    "line-length": {"maximum": 80},
    "no-multiple-empty-lines": {"maximum": 2}
  }
}

4. 典型生态项目

MarkdownLint-CLI2 可以与以下生态项目配合使用：

• vscode-markdownlint：Visual Studio Code 编辑器的 markdownlint 扩展。
• markdownlint-cli2-action：GitHub Action 用于在持续集成过程中运行 MarkdownLint-CLI2。

这些项目可以帮助您在开发过程中维护 Markdown 文档的质量。

markdownlint-cli2 A fast, flexible, configuration-based command-line interface for linting Markdown/CommonMark files with the markdownlint library 项目地址: https://gitcode.com/gh_mirrors/ma/markdownlint-cli2