markdownlint-cli Docker镜像文档

镜像概述和主要用途

markdownlint-cli Docker镜像是基于markdownlint-cli工具的定制容器镜像，专为CI（持续集成）环境优化。该镜像提供轻量级、便捷的Markdown文件语法检查和格式验证能力，可快速集成到自动化流程中，确保Markdown文档符合统一的格式规范。

核心功能和特性

• CI环境优化：镜像设计轻量高效，启动速度快，适合集成到各类CI/CD流水线
• 规则支持：完整支持markdownlint-cli的标准规则集，确保Markdown文件遵循通用语***范
• 灵活配置：支持通过命令行参数自定义检查行为，如指定忽略模式、配置文件等
• 忽略文件支持：可通过-p参数集成.gitignore文件，自动排除无需检查的文件
• 目录挂载：支持本地目录挂载，直接检查宿主机器上的Markdown文件

使用场景和适用范围

• CI/CD流水线集成：在GitHub Actions、GitLab CI、Jenkins等平台中自动检查文档格式
• 本地开发验证：开发人员在提交前本地验证Markdown文件格式
• 文档质量控制：自动化检查README、技术文档等Markdown文件的语法错误和格式问题
• 团队协作规范：确保团队成员提交的Markdown文档符合统一格式标准

详细使用方法和配置说明

基本用法

通过docker run命令启动容器，将本地目录挂载到容器内的/src目录（工具默认工作目录），即可对目录下的Markdown文件进行检查：

docker run -v $(pwd):/src thegeeklab/markdownlint-cli

传递命令行参数

可直接向容器传递markdownlint-cli的命令行参数，自定义检查行为。例如，使用.gitignore文件排除不需要检查的文件：

# 通过-p参数指定忽略模式文件
docker run -v $(pwd):/src thegeeklab/markdownlint-cli -p .gitignore

# 检查特定目录或文件
docker run -v $(pwd):/src thegeeklab/markdownlint-cli docs/*.md

# 查看帮助信息
docker run thegeeklab/markdownlint-cli --help

使用自定义配置文件

markdownlint-cli支持通过配置文件（如.markdownlint.json或.markdownlintrc）自定义检查规则。将配置文件挂载到容器内的/src目录即可生效：

# 挂载自定义配置文件到工作目录
docker run -v $(pwd):/src thegeeklab/markdownlint-cli -c .markdownlint.json

docker-compose配置示例

创建docker-compose.yml文件，集成到本地开发或CI环境：

version: '3'
services:
  markdownlint:
    image: thegeeklab/markdownlint-cli
    volumes:
      - ./:/src  # 挂载当前目录到容器工作目录
    command: -p .gitignore  # 传递忽略模式参数

启动检查：

docker-compose run markdownlint

镜像构建

如需本地构建镜像，执行以下命令：

docker build -t markdownlint-cli:latest .

许可证

本项目基于MIT许可证授权 - 详见LICENSE文件。