avtodev/markdown-lint

Markdown文件检查工具 _{^{| 含预设规则}}

镜像概述

本镜像提供Markdown文件的检查功能，包含markdownlint-cli工具及针对常见场景（如CHANGELOG文件）的自定义规则和配置。可作为Docker镜像直接使用，也支持在GitHub Actions中集成，用于自动化检查Markdown文档的格式规范。所有镜像版本可在Docker Hub获取。

核心功能

1. 集成markdownlint-cli（Node.js工具），支持基础Markdown格式检查；
2. 提供CHANGELOG文件专用检查规则（/lint/rules/changelog.js）；
3. 提供CHANGELOG文件专用配置文件（/lint/config/changelog.yml）；
4. 支持通过命令行参数或环境变量灵活配置检查规则和行为。

使用场景

• 项目开发中检查Markdown文档（如README、文档）的格式规范；
• 验证CHANGELOG文件是否符合团队约定的格式要求；
• 在CI/CD流程（如GitHub Actions）中自动化执行Markdown格式检查，确保提交质量。

配置说明

命令行选项

markdownlint-cli支持以下常用选项（更多细节见https://github.com/igorshubovych/markdownlint-cli%EF%BC%89%EF%BC%9A

• -f, --fix：修复基础错误（不支持STDIN）；
• -c, --config [configFile]：指定配置文件（JSON/JSONC/YAML格式）；
• -r, --rules [path]：指定自定义规则文件；
• -i, --ignore [path]：忽略指定文件/目录。

环境变量

可通过环境变量传递检查配置（支持多个变量组合）：

部署示例

Docker运行

检查本地CHANGELOG.md文件：

bash
docker run --rm \
  -v "$(pwd)/CHANGELOG.md:/CHANGELOG.md:ro" \
  avtodev/markdown-lint:v1 \
  --rules /lint/rules/changelog.js \
  --config /lint/config/changelog.yml \
  /CHANGELOG.md

或通过环境变量配置：

bash
docker run --rm \
  -v "$(pwd)/CHANGELOG.md:/CHANGELOG.md:ro" \
  -e INPUT_RULES=/lint/rules/changelog.js \
  -e INPUT_CONFIG=/lint/config/changelog.yml \
  avtodev/markdown-lint:v1 \
  /CHANGELOG.md

GitHub Actions集成

在工作流中检查CHANGELOG文件：

yaml
jobs:
  lint-changelog:
    name: 检查变更日志格式
    runs-on: ubuntu-latest
    steps:
    - name: 检出代码
      uses: actions/checkout@v2
    - name: 检查CHANGELOG格式
      uses: docker://avtodev/markdown-lint:v1
      with:
        rules: '/lint/rules/changelog.js'
        config: '/lint/config/changelog.yml'
        args: './CHANGELOG.md'

许可证

本镜像基于MIT许可证，可自由使用。 ===FULL_DESC===