https://github.com/sean0x42/markdown-extract

Extract sections of a markdown file. Useful for automatically extracting changelogs
https://github.com/sean0x42/markdown-extract

cli markdown rust

Last synced: 3 months ago
JSON representation

Extract sections of a markdown file. Useful for automatically extracting changelogs

• Host: GitHub
• URL: https://github.com/sean0x42/markdown-extract
• Owner: sean0x42
• License: mit
• Created: 2020-01-20T12:45:09.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-15T05:40:59.000Z (over 1 year ago)
• Last Synced: 2024-07-10T15:21:14.129Z (4 months ago)
• Topics: cli, markdown, rust
• Language: Rust
• Homepage: https://hub.docker.com/r/sean0x42/markdown-extract
• Size: 70.3 KB
• Stars: 27
• Watchers: 2
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Markdown Extract

[![Crates.io](https://img.shields.io/crates/v/markdown-extract)](https://crates.io/crates/markdown-extract)

[![Docker Pulls](https://img.shields.io/docker/pulls/sean0x42/markdown-extract)](https://hub.docker.com/r/sean0x42/markdown-extract)

[![Build & Test](https://github.com/sean0x42/markdown-extract/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/sean0x42/markdown-extract/actions/workflows/build_and_test.yml)



Extract sections of a markdown file with a regular expression! Great for changelogs ;)

## Usage

Given a document called `my-document.md`:

```markdown

# Welcome

This is my amazing markdown document.

## Extract me!

This section should be pulled out.

```

You can extract the second section with the following command:

```console

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

## Extract me!

This section should be pulled out.

```

## Installation

If you've got Rust installed on your system, you can simply install

`markdown-extract` with Cargo.

```console

$ cargo install markdown-extract

```

### Docker

A Docker image is also available, and can be installed with the following

command:

```console

$ docker pull sean0x42/markdown-extract:v2

```

You can then run the container with the following command:

```console

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

```

Note that because markdown-extract accesses the file system, you will need

to mount a volume if you want to access a file on the host. e.g.

``` console

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

```

If you know a better way of achieving this, please let me know!

## Github Action

This project can be used as a Github action.

Here is a sample workflow usage:

```yaml

- id: extract-changelog

  uses: sean0x42/markdown-extract@v2

  with:

   file: CHANGELOG.md

   pattern: 'v2.0.0'

- name: Write output to file

  run: |

    printf '${{ steps.extract-changelog.outputs.markdown }}' > CHANGELOG-extracted.txt

- uses: actions/upload-artifact@v3

  with:

   name: changelog

   path: CHANGELOG-extracted.txt

```

For a complete reference view the [action.yml](action.yml).

The action version corresponds to the version of the tool.

## Use Cases

There aren't many, to be honest. 

1. Extract patch notes from a `CHANGELOG.md` by version.

2. The talented folks at HashiCorp are using `markdown-extract` to extract API

   documentation, and inject it into OpenAPI schemas.

If you have another use for this tool, please let me know!