docker-markdownlint

![构建状态]([] ![Docker Hub 拉取量]([]

![Docker Hub 徽章]([***]

Docker化的markdownlint-cli，支持多种版本，易于使用且便于集成到CI中。

目录

• 使用方法
  • 命令行
    • 使用最新版本
    • 使用特定版本
  • 持续集成（CI）
    • Travis CI
    • GitLab CI
• markdownlint 命令行使用
• 构建

使用方法

命令行

使用最新版本

如果不指定镜像标签，将使用latest标签，对应markdownlint-cli的最新版本：

docker run -v $PWD:/md peterdavehello/markdownlint markdownlint .

• 将$PWD替换为Markdown文件所在路径，$PWD表示当前工作目录。
• 如果不想递归扫描所有Markdown文件，将.替换为具体的文件路径和名称。

使用特定版本

与上述类似，但需指定markdownlint-cli的版本标签，例如0.22.0：

docker run -v $PWD:/md peterdavehello/markdownlint:0.22.0 markdownlint .

持续集成（CI）

Travis CI

在.travis.yml中启用Docker服务：

services:
  - docker

并在scripts部分使用与命令行相同的命令，例如：

services:
  - docker

scripts:
  - docker run -v $TRAVIS_BUILD_DIR:/md peterdavehello/markdownlint:0.22.0 markdownlint example.md

这将检查名为example.md的Markdown文件。

GitLab CI

在.gitlab-ci.yml中添加以下配置块：

markdownlint:
  stage: lint
  variables:
    markdownlint_cli_version: "0.22.0"
  image: peterdavehello/markdownlint:$markdownlint_cli_version
  only:
    changes:
      - "**/*.md"
      - "**/*.markdown"
  script:
    - markdownlint .

markdownlint 命令行使用

向markdownlint传递-h/--help参数可获取帮助信息，例如：

• docker run peterdavehello/markdownlint markdownlint --help

输出如下：

  用法: markdownlint [选项] <文件|目录|通配符>

  MarkdownLint 命令行界面

  选项:

    -h, --help                                  输出使用信息
    -V, --version                               输出版本号
    -f, --fix                                   修复基本错误（不支持STDIN）
    -s, --stdin                                 从STDIN读取（不支持文件）
    -o, --output [outputFile]                   将问题写入文件（不在控制台输出）
    -c, --config [configFile]                   配置文件（JSON、JSONC或YAML）
    -i, --ignore [file|directory|glob]          要忽略/排除的文件
    -r, --rules  [file|directory|glob|package]  自定义规则文件

更多详情，请查看markdownlint-cli项目页面。

构建

构建命令需通过MARKDOWNLINT_CLI_VER参数指定有效的markdownlint版本：

docker build --build-arg MARKDOWNLINT_CLI_VER="0.22.0" -t docker-markdownlint .

# 将"docker-markdownlint"替换为首选镜像名称

可在markdownlint-cli npm registry页面找到有效版本，或访问registry获取更多详情。