markdownlint-docker 镜像文档

镜像概述和主要用途

本镜像基于 git.cryptic.systems/volker.raschek/markdownlint 的构建源码创建，核心目标是将 markdownlint-ci 二进制工具打包为容器化形式。markdownlint-ci 是一款用于 Markdown 文档格式检查的工具，其上游项目为 igorshubovych/markdownlint-cli。本镜像旨在提供便捷的容器化部署方式，方便用户在各类环境中快速集成 Markdown 文档的自动化 lint 检查能力。

核心功能和特性

• 核心工具集成：内置 markdownlint-ci 二进制，支持 Markdown 文档的格式规范检查，包括语法错误、格式不规范等问题检测。
• 容器化部署：通过容器化封装，消除环境依赖差异，可在任意支持 Docker 的环境中运行。
• 上游功能同步：完全继承上游 markdownlint-cli 项目的功能特性，包括丰富的规则配置、文件匹配模式等。

使用场景和适用范围

适用场景

• 开发团队在代码提交前对项目中的 Markdown 文档（如 README.md、API 文档等）进行格式检查，确保文档规范统一。
• 集成到 CI/CD 流程（如 GitHub Actions、GitLab CI、Jenkins 等），实现文档格式检查的自动化，避免不规范文档进入代码库。
• 本地开发环境中，快速验证 Markdown 文档格式，减少人工检查成本。

适用范围

• 需要对 Markdown 文档进行自动化格式检查的个人开发者或团队。
• 追求文档质量标准化、希望通过工具强制规范文档格式的项目。

详细使用方法和配置说明

基本使用方法

本镜像的使用流程与上游 markdownlint-cli 项目一致，详细使用说明可参考 上游文档。

容器运行示例

以下为通过 docker run 命令运行镜像检查 Markdown 文件的基础示例（检查当前目录下的所有 .md 文件）：

docker run --rm -v $(pwd):/workspace git.cryptic.systems/volker.raschek/markdownlint markdownlint-ci *.md

说明：-v $(pwd):/workspace 用于将本地目录挂载到容器内的 /workspace 工作目录，确保工具可访问待检查的 Markdown 文件。

配置说明

markdownlint-ci 的规则配置方式与上游项目一致，支持通过项目根目录下的 .markdownlint.json 或 .markdownlintrc 文件自定义检查规则。具体配置选项可参考 上游规则文档。

上游项目参考

• 工具核心功能文档：igorshubovych/markdownlint-cli
• 使用方法详情：markdownlint-cli Usage