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] FILE

  Generates badges from a file.

Options:
  FILE        The file to use for generation of badges.  [required]
  --inplace   Writes back to file instead of to stdout.
  -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, word by word
2. It tries to find simple-icons for every word
3. It replaces the word by badge either inplace or writes the output to console

❤️ Contributing

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