https://github.com/deep5050/autobadge
Simple CLI tool to generate essential repository badges with ease
https://github.com/deep5050/autobadge
badge badge-generator badgen badgennet badges cli documentation github markdown-it readme readme-generator readme-template shieldsio
Last synced: 6 months ago
JSON representation
Simple CLI tool to generate essential repository badges with ease
- Host: GitHub
- URL: https://github.com/deep5050/autobadge
- Owner: deep5050
- License: mit
- Created: 2020-05-26T08:57:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-25T23:42:49.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T11:09:22.658Z (about 1 year ago)
- Topics: badge, badge-generator, badgen, badgennet, badges, cli, documentation, github, markdown-it, readme, readme-generator, readme-template, shieldsio
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/autobadge
- Size: 60.5 KB
- Stars: 19
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
AutoBadge
Interactive . Smart . Efficient
A simple CLI tool to generate essential repository badges with ease.
It asks for minimum information from the user and produces all (almost) the essential badges
## Why use?
Digging the internet for getting common badges is not a handy way. Why not use a
script and answer few questions to generate them? Huh?! :sunglasses:
## How to use?
Install it globally :
Run `npm install -g autobadge` and `autobadge`, that'S it :zap:
## Supports
- [x] MarkDown
- [x] HTML
- [x] Shields Badges
## Style
- [x] Flat
- [x] Flat-Square
- [x] Plastic
- [x] Social
- [x] For-The-Badge
## What's New in 1.3.1?
- [x] Clickable badge when in HTML format
- [x] Separate URLs for each badges
## TODO
- [ ] HTML alignment support
- [ ] Ad shields badges
- [ ] Badgen badges
- [ ] ForTheBadge badges
## Result (More Coming Soon....)
## License Badges
| Syntax | Badge |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `
` | |
## Social Badges
| Syntax | Badge |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `
` | |
| `
` | |
| `
` | |
| `
` | |
| `
` | |
## Size Badges
| Syntax | Badge |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `
` | |
## Issues Badges
| Syntax | Badge |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `
` | |
| `
` | |
| `
` | |
| `
` | |
## Analysis Badges
| Syntax | Badge |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `
` | |
| `
` | |
## Activity Badges
| Syntax | Badge |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `
` | |
| `
` | |
| `
` | |
| `
` | |
## Version Badges
| Syntax | Badge |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `
` | |
## CI/CD Badges
| Syntax | Badge |
| :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `` | |
## Other Badges
| Syntax | Badge |
| :------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------: |
| `
` | |
# My Other Works
qikQR : Minimal Cross-Platform QR
Code Generator Desktop App
Autopy-Lot: Github Action To
Convert Jupyter Notebook To Python Script
### MIT (c) 2020 Dipankar Pal