Markdown Extract

Extract sections of a markdown file. This project mostly exists to help me learn Rust, and to fill a niche requirement for extracting patch notes from a CHANGELOG.md.

Installation

If you've got Rust installed on your system, you can simple install markdown-extract with Cargo.

$ cargo install markdown-extract

Docker

A Docker container is also available, and can be installed with the following command:

$ docker pull sean0x42/markdown-extract

You can then run the container with the following command:

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

Usage

View the help guide if you like.

$ markdown-extract --help
markdown-extract 1.1.0
Extract sections of a markdown file

USAGE:
    markdown-extract [FLAGS] <pattern> <path>

FLAGS:
    -s, --case-sensitive          Treat pattern as case sensitive
    -f, --first                   Only return the first match
    -h, --help                    Prints help information
    -i, --ignore-first-heading    Do not include the top level section heading
    -r, --regex                   Compile pattern as a regular expression
    -V, --version                 Prints version information

ARGS:
    <pattern>    Pattern to match against section headings
    <path>       Path to markdown file

Then extract matching sections in a markdown file.

$ markdown-extract --fr "^v1" CHANGELOG.md
## v1.1.0

...

Use Cases

There aren't many. I created this tool to extract patch notes from a CHANGELOG.md by version. If you have another use for this binary, please let me know!