auto-markdown-badges

Auto-generated markdown badges. 🧙🖼

Inspired by markdown-badges, I wanted to have a tool which automatically creates badges for me.

🚀 Get started

To install it from PyPI run:

pip install auto-markdown-badges

Then just call it like this:

Usage: auto-markdown-badges generate [OPTIONS] INPUT_FILE

  Generates badges from a file.

Options:
  INPUT_FILE                      The file to use for generation of badges.
                                  [required]
  -o, --output-file FILE          The file to output to.
  -p, --placement [header|inplace|footer]
                                  Specify where to place the badge.  [default:
                                  Placement.INPLACE]
  -h, --help                      Show this message and exit.

Examples of generated badges can be found in the examples directory.

🤔 How it Works

1. It reads the given file, line by line
2. It tries to find simple-icons for every word
3. It replaces the word with a badge

❤️ Contributing

Contributions are very welcome. Please go ahead and raise an issue if you have one or open a PR. Thank you.