zemanlx/remark-lint

remark-lint的Docker镜像

用于markdown代码风格检查工具https://github.com/remarkjs/remark-lint%E7%9A%84Docker%E9%95%9C%E5%83%8F%E3%80%82

获取镜像

从https://hub.docker.com/r/zemanlx/remark-lint/%E6%8B%89%E5%8F%96%E9%95%9C%E5%83%8F%EF%BC%9A

bash
docker pull zemanlx/remark-lint

构建镜像

克隆此仓库并运行：

bash
docker build -t zemanlx/remark-lint .

使用方法

进入包含要检查的markdown文件的文件夹并运行：

bash
docker run --rm -i -v $PWD:/lint/input:ro zemanlx/remark-lint .

你甚至可以将其设置为remark-cli命令remark的别名：

bash
alias remark="docker run --rm -i -v $PWD:/lint/input:ro zemanlx/remark-lint"

remark --version
remark: 9.0.0, remark-cli: 5.0.0

默认配置文件为.remarkrc.yaml：

yaml
plugins:
  preset-lint-consistent:
  preset-lint-markdown-style-guide:
  preset-lint-recommended:
  validate-links:

使用示例

bash
docker run --rm -i -v $PWD:/lint/input:ro zemanlx/remark-lint .

README.md
  3:100  warning  Line must be at most 80 characters  maximum-line-length         remark-lint
    8:1  warning  Remove 1 line before node           no-consecutive-blank-lines  remark-lint

⚠ 2 warnings

规则自定义

如果需要自定义规则（如maximum-line-length），可在examples文件夹中找到JSON和YAML格式的配置示例。只需将其复制到项目根目录并进行自定义即可。

所有规则列表可查看https://github.com/remarkjs/remark-lint/tree/master/packages%E3%80%82

持续集成

在CI中，-f或--frail选项非常有用，当存在任何警告时将以代码1退出：

bash
docker run --rm -i -v $PWD:/lint/input:ro zemanlx/remark-lint --frail .

Travis CI配置

最小配置示例：

yaml
# 运行检查器需要Docker
sudo: required
services:
  - docker
# 使用你的语言或通用镜像以减少启动时间
language: generic
install:
  - docker pull zemanlx/remark-lint
script:
  - docker run --rm -i -v $PWD:/lint/input:ro zemanlx/remark-lint --frail .

你可以扩展此示例，添加构建指令和测试，或将其作为某个阶段的任务。