thegeeklab/markdownlint-cli

markdownlint-cli Docker镜像文档

镜像概述和主要用途

markdownlint-cli Docker镜像是基于https://github.com/igorshubovych/markdownlint-cli%E5%B7%A5%E5%85%B7%E7%9A%84%E5%AE%9A%E5%88%B6%E5%AE%B9%E5%99%A8%E9%95%9C%E5%83%8F%EF%BC%8C%E4%B8%93%E4%B8%BACI%EF%BC%88%E6%8C%81%E7%BB%AD%E9%9B%86%E6%88%90%EF%BC%89%E7%8E%AF%E5%A2%83%E4%BC%98%E5%8C%96%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E6%8F%90%E4%BE%9B%E8%BD%BB%E9%87%8F%E7%BA%A7%E3%80%81%E4%BE%BF%E6%8D%B7%E7%9A%84Markdown%E6%96%87%E4%BB%B6%E8%AF%AD%E6%B3%95%E6%A3%80%E6%9F%A5%E5%92%8C%E6%A0%BC%E5%BC%8F%E9%AA%8C%E8%AF%81%E8%83%BD%E5%8A%9B%EF%BC%8C%E5%8F%AF%E5%BF%AB%E9%80%9F%E9%9B%86%E6%88%90%E5%88%B0%E8%87%AA%E5%8A%A8%E5%8C%96%E6%B5%81%E7%A8%8B%E4%B8%AD%EF%BC%8C%E7%A1%AE%E4%BF%9DMarkdown%E6%96%87%E6%A1%A3%E7%AC%A6%E5%90%88%E7%BB%9F%E4%B8%80%E7%9A%84%E6%A0%BC%E5%BC%8F%E8%A7%84%E8%8C%83%E3%80%82

核心功能和特性

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

使用场景和适用范围

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

详细使用方法和配置说明

基本用法

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

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

传递命令行参数

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

bash
# 通过-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目录即可生效：

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

docker-compose配置示例

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

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

启动检查：

bash
docker-compose run markdownlint

镜像构建

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

bash
docker build -t markdownlint-cli:latest .

许可证

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