pipelinecomponents/markdownlint

Pipeline Components: Markdownlint

镜像状态

https://hub.docker.com/r/pipelinecomponents/markdownlint https://hub.docker.com/r/pipelinecomponents/markdownlint

概述

该镜像为GitLab CI环境提供Markdownlint工具的容器化部署，用于对Markdown文档进行语法检查和风格验证。Markdownlint安装在/app/目录下，支持使用前进行自定义配置，便于集成到CI/CD流水线的代码审查阶段，实现文档质量的自动化管控。

核心功能

• 提供Markdown语法错误检测与风格一致性验证
• 支持自定义检查规则与风格配置
• 可集成到GitLab CI等CI/CD平台实现自动化检查
• 安装路径为/app/，支持使用前进行定制化安装

使用场景

适用于需要对项目中的Markdown文档（如README、API文档、技术文档等）进行格式规范检查的场景，尤其适合在GitLab CI的linting阶段集成，作为代码审查流程的一部分，确保文档质量符合团队规范。

使用方法

基本用法

通过GitLab CI配置文件集成该镜像，在linting阶段执行Markdown检查命令。

GitLab CI配置示例

yaml
markdownlint:
  stage: linting
  image: registry.gitlab.com/pipeline-components/markdownlint:latest
  script:
    - mdl --style all --warnings .  # 使用所有风格检查规则，显示警告信息，检查当前目录下的文件

命令参数说明

• --style：指定检查风格（如all表示所有风格规则）
• --warnings：显示警告级别的问题（非错误但需注意的格式问题）
• .：指定检查路径（当前目录）

规则与配置

有关Markdownlint的详细检查规则和配置方法，请参见https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md。

版本控制

本项目采用语义化版本控制进行版本管理。

支持

如有疑问：

• 可查看***频道
• 或提交issue

贡献指南

这是一个活跃的开源项目，欢迎使用或贡献代码。贡献指南详见单独文档。感谢您的参与！😍

作者与贡献者

本仓库的初始搭建由Robbert Müller完成。构建流水线主要基于https://github.com/hassio-addons（由https://github.com/frenck开发）。完整的作者和贡献者列表请查看贡献者页面。

许可证

本项目由Robbert Müller根据MIT许可证授权。