hugojosefson/markdown Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

hugojosefson/markdown 镜像文档

镜像概述和主要用途

hugojosefson/markdown是一个Docker镜像，主要功能是将Markdown语法渲染为HTML格式。它基于Alpine Linux构建，集成了PlantUML渲染、GitHub风格Markdown支持等功能，可通过简单的命令行操作实现Markdown到HTML的转换。

核心功能和特性

• Markdown转HTML：支持标准Markdown语法转换为HTML
• PlantUML集成：可渲染PlantUML图表，支持PNG、SVG、TXT等格式
• GitHub风格Markdown：支持GitHub Flavored Markdown (GFM)特性，如任务列表
• 链接转换配置：通过环境变量自定义链接转换规则
• 轻量级：基于Alpine Linux，镜像体积小，运行高效

使用场景和适用范围

• 文档转换：将Markdown文档批量转换为HTML
• 静态网站生成：配合CI/CD流程自动生成HTML文档
• 本地开发：快速预览Markdown文件渲染效果
• 集成系统：作为服务组件嵌入到文档处理流程中

使用方法和配置说明

基本用法

通过管道将Markdown内容输入容器，即可输出HTML结果：

bash
cat [Markdown文件] | docker run --rm -i hugojosefson/markdown > [输出HTML文件]

示例

1. 将README.md转换为HTML

bash
cat README.md | docker run --rm -i hugojosefson/markdown > README.html

2. 手动探索镜像

bash
docker run --rm -it --entrypoint=bash hugojosefson/markdown

配置选项

可通过docker run --env设置以下环境变量：

支持的内容示例

PlantUML图表

plantuml
@startuml
Alice -> Bob : POST /hello_png
@enduml

plantuml
@startuml
Alice -> Bob : POST /hello_svg
@enduml

plantuml
@startuml
Alice -> Bob : POST /hello_txt
@enduml

GitHub风格Markdown

输入：

markdown
 - [ ] todo
 - [x] done

输出：

• todo
• done

致谢

本项目基于以下组件构建：

• mikitex70/plantuml-markdown
• py-gfm（GitHub风格Markdown支持）
• sindresorhus.com/github-markdown-css

该镜像从kerhac/plantuml-markdown-docker分叉而来。