Pipeline Components: Markdownlint-cli2

Docker 状态

概述

该镜像用于运行 markdownlint-cli2，这是一款 Markdown 文件 linting 工具，可检查 Markdown 文件的语***范性。markdownlint-cli2 安装在 /app/ 目录下，便于在使用前根据需求进行自定义配置。有关工具的详细文档，请参见 markdownlint-cli2 文档，规则和配置的更多信息可参考 规则说明。

核心功能与特性

• 容器化运行 markdownlint-cli2，简化环境配置
• 支持对 Markdown 文件进行语法检查和规范验证
• 安装路径 /app/ 允许使用前自定义工具配置
• 适配 GitLab CI 环境，可直接集成到 CI/CD 流程

使用场景与适用范围

主要适用于 GitLab CI 的 linting 阶段，对项目中的 Markdown 文件（如文档、README 等）进行自动化语法检查，确保文件符合指定规范，提升文档质量。

使用方法与配置说明

GitLab CI 配置示例

在 GitLab CI 配置文件（如 .gitlab-ci.yml）中，可添加如下阶段配置：

yaml
markdownlint-cli2:
  stage: linting
  image: registry.gitlab.com/pipeline-components/markdownlint-cli2:latest
  script:
    - markdownlint-cli2 .

上述配置会在 linting 阶段使用该镜像，执行 markdownlint-cli2 . 命令检查当前目录下所有 Markdown 文件。

版本控制

本项目采用 语义化版本控制 进行版本编号。

支持

有问题？您有多种方式获取解答：

• 查看 *** 频道
• 也可 在此提交 issue

贡献

这是一个活跃的开源项目。我们始终欢迎希望使用代码或为之贡献的人参与。

我们单独编写了 贡献指南 文档。

感谢您的参与！😊

作者与贡献者

该仓库的初始设置由 Robbert Müller 完成。

构建流程主要基于 Community Hass.io Add-ons，作者为 Franck Nijhof。

完整的作者和贡献者列表，请查看 贡献者页面。

许可证

MIT 许可证

版权所有 (c) 2023 Robbert Müller

特此授予获得本软件及相关文档文件（以下简称“软件”）副本的任何人免费使用、复制、修改、合并、出版、发行、再许可和/或销售软件副本的权利，前提是上述版权声明和本许可声明包含在所有副本或实质性部分中。

本软件按“原样”提供，不提供任何明示或暗示的担保，包括但不限于适销性、特定用途适用性和非侵权性的担保。在任何情况下，作者或版权持有人均不对因软件或软件使用引起的任何索赔、损害或其他责任承担责任，无论是合同诉讼、侵权诉讼还是其他形式的诉讼。