markdown index

Markdown-index is a library to help you generate a global index for multiple markdown files recursively in a directory, containing a summary of every file found.

Installation

The easiest way to install it is using Homebrew:

brew tap mmiranda/apps
brew install markdown-index

If you prefer, you also can download the latest binary on the release section, or simply use the pre-built dockerfile image

Usage

You can use this tool using multiple ways:

Running Local

cd some-directory
markdown-index

Dockerfile

docker pull ghcr.io/mmiranda/markdown-index:latest
docker run --rm -it -v /path/to/root/md/files:/data ghcr.io/mmiranda/markdown-index:latest

After running the command, a new markdown file will be created containing a summary of every other file found.

Github Actions

Yes, you can integrate this tool into your pipeline.

Check the live-example for GH Actions and copy it to your own repo!

Contributing

Contributions, issues, and feature requests are welcome!

Give a ⭐️ if you like this project!

License

MIT