davidanson/markdownlint-cli2-rules

markdownlint-cli2 Docker 镜像文档

概述

markdownlint-cli2 Docker 镜像包含 markdownlint-cli2 命令行工具，用于对 Markdown 文件进行 linting 检查。该工具基于 markdownlint 库，支持自定义规则，可帮助用户确保 Markdown 文件的语***范性和格式一致性。

核心功能与特性

• 基于 markdownlint 库：集成 markdownlint 核心规则，提供基础的 Markdown 语法和格式检查能力
• 自定义规则支持：允许通过配置文件定义或扩展规则，满足特定项目的格式要求
• 命令行界面：提供简洁的 CLI，支持通过命令行参数指定检查文件、配置规则等
• 轻量级设计：镜像体积小巧，适合集成到开发环境或 CI/CD 流程中

使用场景

• 开发环境检查：在本地开发过程中对 Markdown 文档（如 README、技术文档等）进行实时格式校验
• CI/CD 集成：作为 CI/CD 流程的一部分，自动检查提交的 Markdown 文件，确保文档质量
• 文档项目管理：对大型文档项目中的 Markdown 文件进行批量检查，统一格式规范

使用方法与配置说明

基本使用

通过 Docker 运行镜像，挂载包含 Markdown 文件的目录，并执行 linting 检查：

bash
docker run --rm -v "$(pwd):/workdir" docker.xuanyuan.run/markdownlint-cli2:latest "**/*.md"

参数说明

• --rm：容器运行结束后自动删除
• -v "$(pwd):/workdir"：将当前目录挂载到容器内的 /workdir 目录（工作目录）
• "**/*.md"：指定要检查的 Markdown 文件路径（支持 glob 模式）

自定义规则配置

通过挂载自定义配置文件（如 .markdownlint-cli2.jsonc）来自定义规则：

1. 在本地创建配置文件 .markdownlint-cli2.jsonc，示例内容：

   jsonc
   {
     "config": {
       "MD007": false,  // 禁用 "无序列表缩进" 规则
       "MD013": { "line_length": 120 }  // 调整 "行长度" 规则的行长度为 120
     }
   }
   

2. 运行容器时挂载配置文件：

   bash
   docker run --rm -v "$(pwd):/workdir" docker.xuanyuan.run/markdownlint-cli2:latest --config .markdownlint-cli2.jsonc "**/*.md"
   

docker-compose 配置示例

创建 docker-compose.yml 文件，集成到项目中：

yaml
version: '3'
services:
  markdownlint:
    image: docker.xuanyuan.run/markdownlint-cli2:latest
    volumes:
      - .:/workdir
    command: ["**/*.md"]

运行检查：

bash
docker-compose run --rm markdownlint

更多信息

有关详细使用说明、规则配置及高级功能，可参考官方 GitHub 页面：
https://github.com/DavidAnson/markdownlint-cli2