Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaelcurrin/badge-generator
Magically generate Markdown badges for your docs 🛡️ 🦡 🧙
https://github.com/michaelcurrin/badge-generator
badge badge-generator boilerplate docs-generator documentation-generator documentation-tool javascript markdown markdown-badges nodejs readme-badge readme-badges shield shields shields-io shieldsio typescript vue
Last synced: 13 days ago
JSON representation
Magically generate Markdown badges for your docs 🛡️ 🦡 🧙
- Host: GitHub
- URL: https://github.com/michaelcurrin/badge-generator
- Owner: MichaelCurrin
- License: mit
- Created: 2020-01-26T11:27:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-21T07:11:00.000Z (about 2 months ago)
- Last Synced: 2024-10-12T19:36:38.247Z (about 1 month ago)
- Topics: badge, badge-generator, boilerplate, docs-generator, documentation-generator, documentation-tool, javascript, markdown, markdown-badges, nodejs, readme-badge, readme-badges, shield, shields, shields-io, shieldsio, typescript, vue
- Language: TypeScript
- Homepage: https://michaelcurrin.github.io/badge-generator/
- Size: 35.8 MB
- Stars: 387
- Watchers: 8
- Forks: 113
- Open Issues: 82
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Badge Generator
:shield: :badger: :mage:
> Magically generate Markdown badges for your docs
[](https://github.com/MichaelCurrin/badge-generator/actions/workflows/main.yml "GitHub Actions workflow status")
[](https://github.com/MichaelCurrin/badge-generator/releases/?include_prereleases&sort=semver "View GitHub releases")
[](#license "Go to license section")
[](https://github.com/MichaelCurrin/badge-generator/actions?query=workflow%3ACodeQL "Code quality workflow status")
[](https://snyk.io/test/github/MichaelCurrin/badge-generator?targetFile=package.json "Snyk vulnerabilities")
[](https://nodejs.org "Go to Node.js homepage")
[](https://classic.yarnpkg.com "Go to Yarn classic homepage")
[](https://www.npmjs.com/package/vue "Go to Vue on NPM")
[](https://www.npmjs.com/package/typescript "Go to TypeScript on NPM")
[Website](https://michaelcurrin.github.io/badge-generator/) — [Sample badges](#sample-badges) — [Documentation](/docs/#readme)
## Overview
A convenience tool that makes it easy to generate custom Markdown for badges to put on your documentation or website.
Choose a page, enter your details, and click _Submit_ to generate some Markdown code for you to copy and paste.
External tools are used to actually render badges - mostly using [shields.io](https://shields.io).
## Preview
## Open the web app
Start creating badges for your docs.
[](https://michaelcurrin.github.io/badge-generator/)
## Sample badges
Examples of a few badges generated with the app and rendered here on a markdown doc
Note that most of the badges at the top of this `README.md` file were also generated using this app.
### Social badges
Link to your project. From another project - even paste these in an online forum or your blog.
[](https://github.com/MichaelCurrin/badge-generator)
[](https://github.com/MichaelCurrin/badge-generator)
[](https://github.com/MichaelCurrin/badge-generator)
### Repo metadata
Add to the top of your `README.md` file. These are about your specific repo. Some are dynamic and some are hardcoded (like license below).
[](https://github.com/MichaelCurrin/badge-generator/releases/)
[](#license)
[](https://github.com/MichaelCurrin/badge-generator/issues)
### Generic
Put whatever text value you want in this static (fixed) badge. You can change the color, logo and destination link. Use the badge for your repo, website or documentation.
[](#)
### Packages
You might want to list a dependency of your repo with the value actually in use, instead of a static badge.
Here we have Vue listed as a dependency of this Badge Generator repo and the version number changes to reflect what is in the `package.json` file.
[](https://www.npmjs.com/package/vue)
### Dynamic data
Similar to above but more flexible.
Create a badge that references _any_ value within a public data file (currently only JSON files are supported by Badge Generator). The badge stays up to date with whatever value is in the target file.
In the example below, we lookup the version of VS Code IDE needed by a VS Code extension. The query is `$.engines.vscode` and that is done against this target [package.json](https://github.com/MichaelCurrin/auto-commit-msg/blob/master/package.json) file on GitHub.
### Catalogue
Pre-made badges around languages and tools. Just copy and paste them - no form input needed. You might put a static value there for what version you support without making it dynamic.
If you can't find a badge you're looking for there, use the Generic badge option to make your own.
[](https://www.linux.org/ "Go to Linux homepage")
[](https://www.gnu.org/software/bash/ "Go to Bash homepage")
[](https://python.org "Go to Python homepage")
## Documentation
> User guide for using the app and how setup and run the app yourself
[](/docs/#readme "Go to project documentation")
## License
Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).
- You can freely modify and reuse.
- The _original license_ must be included with copies of this software.
- Please _link back_ to this repo if you use a significant portion the source code.