sean0x42/markdown-extract

Markdown Extract 镜像文档

镜像概述

Markdown Extract 是一个轻量级工具，用于从Markdown文件中提取特定章节内容。通过正则表达式匹配标题，可精准提取对应section内容，特别适用于从变更日志(CHANGELOG.md)中提取版本说明等场景。提供Docker镜像形式，便于快速部署和使用，无需本地配置Rust环境。

核心功能与特性

• 精准提取：通过正则表达式匹配Markdown标题，提取对应章节内容
• 轻量高效：基于Rust开发，性能优异，资源占用低
• 容器化部署：提供Docker镜像，支持跨平台运行
• 文件系统访问：可处理本地文件，需通过卷挂载实现主机文件访问

使用场景

1. 变更日志提取：从CHANGELOG.md中按版本号提取对应补丁说明
2. API文档处理：提取特定API文档内容并注入OpenAPI schema（HashiCorp实际应用案例）
3. 文档片段提取：从大型Markdown文档中提取指定章节内容

安装与使用说明

Docker镜像安装

拉取最新版本镜像：

console
docker pull sean0x42/markdown-extract:v2

基本使用方法

查看工具帮助信息：

console
docker run -it sean0x42/markdown-extract:v2 --help

处理主机文件

由于工具需要访问文件系统，处理本地文件时需将主机目录挂载为卷：

console
docker run -v [主机目录]:/opt -it sean0x42/markdown-extract:v2 [匹配模式] /opt/[目标文件]

参数说明

• [主机目录]：本地Markdown文件所在目录（如当前目录可使用$PWD）
• [匹配模式]：用于匹配标题的正则表达式（如版本号"v2.0.0"或章节标题"Extract me!"）
• [目标文件]：需处理的Markdown文件名（路径相对于挂载卷的根目录）

使用示例

示例文件

假设有本地文件my-document.md，内容如下：

markdown
# Welcome

This is my amazing markdown document.

## Extract me!

This section should be pulled out.

提取指定章节

执行以下命令提取标题为"Extract me!"的章节：

console
docker run -v $PWD:/opt -it sean0x42/markdown-extract:v2 "Extract me!" /opt/my-document.md

输出结果

## Extract me!

This section should be pulled out.

从变更日志提取版本说明

提取CHANGELOG.md中版本v2.0.0的内容：

console
docker run -v $PWD:/opt -it sean0x42/markdown-extract:v2 v2.0.0 /opt/CHANGELOG.md