wpengine/mdl

mdl 镜像文档

镜像概述

mdl镜像是一个最小化的markdown检查工具镜像，集成了与WPE标准相关的自定义规则，主要用于对markdown文件进行规范检查（linting），确保文档符合指定格式标准。

核心功能与特性

• 最小化设计：镜像体积小，部署快速
• WPE标准支持：内置与WPE标准相关的自定义检查规则
• 灵活配置：支持通过外部配置文件覆盖默认规则

使用场景

适用于需要对markdown文档进行格式规范检查的场景，如：

• 开发团队的技术文档规范检查
• 开源项目的文档质量控制
• 内容创作过程中的格式校验

使用方法

基本使用

通过挂载本地目录到容器的/workspace目录，对指定目录下的markdown文件进行检查：

bash
docker run --rm -v `pwd`:/workspace wpengine/mdl /workspace

参数说明：

• --rm：容器运行结束后自动删除
• -v pwd:/workspace：将当前目录挂载到容器内的/workspace目录
• wpengine/mdl：镜像名称
• /workspace：指定要检查的目录路径

自定义配置

镜像内置了.mdlrc配置文件，如需使用自定义配置，需通过挂载覆盖默认配置文件：

bash
docker run --rm -v `pwd`:/workspace -v /full/path/to/.mdlrc:/mdl/.mdlrc wpengine/mdl /workspace

说明：

• /full/path/to/.mdlrc：本地自定义配置文件的完整路径
• /mdl/.mdlrc：容器内默认配置文件路径，通过挂载覆盖此路径实现自定义配置