⭐Create
This command displays prompts to create your own badge.
To start, run:
then follow the prompts that follow.
As an example, we are going to create a custom GitHub badge which links to the mdbadges-cli repository.
Yellow text is the area that your answers to the prompts will fill out.
Prompts
Alt Text is the text enclosed within the first square brackets.
In our example, this is [![mdbadges-cli]...
Text to display on the badge is the actual text that will be shown on the badge image.
In our example, we enter mdbadges-cli within the prompt, so this becomes https://img.shields.io/badge/mdbadges-cli-%... in the URL.
Note: Handling is handled automatically by mdbadges-cli in most cases.
The hexadecimal value is the hex color for the background of the badge.
In our example, this is ...mdbadges-cli-000000...
The logo is the logo that will be displayed on the badge.
In our example, this is logo=github...
The logo color is the color that will the logo will use on the badge.
In our example, this is logoColor=white...
The style determines which style the badge will use.
Here are the valid syntax for this area:
flat
flat-square
plastic
social
for-the-badge
In our example, this is ...style=for-the-badge...
The link is an optional field and is the link that the badge will redirect to when clicked on.
In our example, this is ...style=for-the-badge)](https://github.com/inttter/mdbadges-cli)
If you have been following this example, this is what the prompts should look like:
With those steps completed, you should have a badge that you can now use in either your Markdown or your HTML webpage!
Last updated