tianon/markdownfmt

markdownfmt Docker镜像

概述

markdownfmt Docker镜像是一个容器化的Markdown格式化工具，基于Go语言实现的markdownfmt工具构建。该镜像提供了一种便捷方式来格式化Markdown文件，确保文档风格的一致性和规范性，无需在本地环境安装相关依赖。

核心功能和特性

• 便捷格式化：快速格式化单个或多个Markdown文件
• 风格一致：确保团队协作中的文档格式统一
• 零依赖：容器化设计，无需在本地安装Go环境或其他依赖
• 轻量级：基于Alpine Linux构建，镜像体积小
• 可定制：支持通过命令行参数自定义格式化规则

使用场景和适用范围

• 个人文档整理和格式化
• 团队协作中的Markdown文档标准化
• CI/CD流程中集成文档格式化检查
• 开源项目文档自动格式化
• 博客文章和技术文档的批量格式化处理

使用方法和配置说明

基本用法

格式化当前目录下的单个Markdown文件：

bash
docker run --rm -v "$(pwd):/data" tianon/markdownfmt input.md

格式化并覆盖原文件

bash
docker run --rm -v "$(pwd):/data" tianon/markdownfmt -w input.md

格式化多个文件

bash
docker run --rm -v "$(pwd):/data" tianon/markdownfmt file1.md file2.md file3.md

查看帮助信息

bash
docker run --rm tianon/markdownfmt -h

常用命令行参数

• -w: 直接修改文件而非输出到标准输出
• -d: 仅显示差异而非修改文件
• -l: 仅列出需要格式化的文件
• -tabs: 使用制表符而非空格进行缩进
• -width: 设置换行宽度，默认为80个字符

docker-compose集成示例

创建docker-compose.yml文件：

yaml
version: '3'
services:
  markdownfmt:
    image: tianon/markdownfmt
    volumes:
      - ./docs:/data
    command: -w /data/*.md

运行格式化：

bash
docker-compose run --rm markdownfmt

在CI/CD中使用

可在CI/CD流程中添加以下步骤，确保提交的Markdown文件符合格式要求：

bash
# 检查是否有需要格式化的文件
docker run --rm -v "$(pwd):/data" tianon/markdownfmt -l *.md | grep -q . && echo "需要格式化的文件存在" && exit 1 || exit 0

注意事项

• 使用-w参数时会直接修改原文件，请确保在格式化前做好文件备份或使用版本控制系统
• 对于大型Markdown文件，可能需要适当增加容器内存限制
• 默认情况下，工具会保留原始文件的编码格式和行尾符