5 个版本 (3 个稳定版)

2.0.0 2022年1月16日
1.1.0 2020年4月24日
1.0.0 2020年1月30日
0.1.1 2020年1月23日
0.1.0-alpha2020年1月22日

#769 in 文本处理

Download history 42/week @ 2024-03-11 45/week @ 2024-03-18 12/week @ 2024-03-25 89/week @ 2024-04-01 29/week @ 2024-04-08 29/week @ 2024-04-15 37/week @ 2024-04-22 28/week @ 2024-04-29 28/week @ 2024-05-06 31/week @ 2024-05-13 42/week @ 2024-05-20 32/week @ 2024-05-27 77/week @ 2024-06-03 29/week @ 2024-06-10 8/week @ 2024-06-17 23/week @ 2024-06-24

每月 140 次下载
4 个 Crates 中使用 (通过 agpm_suggestions)

MIT 许可证

10KB
189

Markdown Extract

Crates.io Docker Pulls Build & Test

使用正则表达式从 markdown 文件中提取部分内容!非常适合变更日志 ;)

用法

假设有一个名为 my-document.md 的文档

# Welcome

This is my amazing markdown document.

## Extract me!

This section should be pulled out.

您可以使用以下命令提取第二个部分

$ markdown-extract "Extract me!" my-document.md
## Extract me!

This section should be pulled out.

安装

如果您已经在系统上安装了 Rust,您可以使用 Cargo 安装 markdown-extract

$ cargo install markdown-extract

Docker

也有可用的 Docker 镜像,可以使用以下命令安装

$ docker pull sean0x42/markdown-extract:v2

然后您可以使用以下命令运行容器

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

请注意,由于 markdown-extract 访问文件系统,如果您想访问主机上的文件,您需要挂载一个卷。例如。

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

如果您知道更好的实现方式,请告诉我!

使用场景

老实说,并不多。

  1. 按版本提取 CHANGELOG.md 中的补丁说明。
  2. HashiCorp 的才华横溢的人们正在使用 markdown-extract 来提取 API 文档,并将其注入到 OpenAPI 架构中。

如果您有其他使用此工具的场景,请告诉我!

依赖项

~6MB
~104K SLoC