Add badges to your Profile and Projects.
- Markdown Badges
- Table of contents
- Usage
- Examples
- Tips
- Contribution
- License
- Badges
-
List of badges
- Artificial Intelligence and Bots
- Blog
- Blockchain
- Browsers
- CD
- CI
- Cloud Storage
- Cryptocurrency
- Databases
- Design
- Developer/Forums
- Documentation Platforms
- Education
- Funding
- Frameworks, Platforms and Libraries
- Gaming
- Game Consoles
- Hosting/SaaS
- IDEs/Editors
- Languages
- ML/DL
- Music
- Office
- Operating System
- ORM
- Other
- Quantum Programming Frameworks and Libraries
- Search Engines
- Servers
- Smartphone Brands
- Social
- Store
- Streaming
- Testing
- Version Control
- Wearables
- Work/Jobs
-
To use a badge:
- Via Github
- Create entries
<!--START_SECTION:stack-->
and<!--END_SECTION:stack-->
into your README.md file - Press
Ctrl
+f
on your keyboard, to bring out the search modal. - Enter the name of the badge you need.
- Copy the name of the badge you want to use
- Enter the name in the variables section of the job
- Create entries
- You could also visit the live site at ileriayo.github.io/markdown-badges/
Add the following entries: <!--START_SECTION:stack-->
and <!--END_SECTION:stack-->
into your README.md file.
Create a file called badges-action-markdown.yml under the .github/workflows directory
on:
push:
branches:
- 'master'
paths:
- '.github/workflows/badges-action-markdown.yml'
jobs:
update-profile-badges:
runs-on: ubuntu-latest
name: Update profile badges
steps:
- name: Update Badges
uses: kamuridesu/markdown-badges@v0.0.2
with:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
BADGES: "Python Golang Java 'Sublime Text' 'Visual Studio Code'"
Note that to choose tools where their names contains spaces, you can use simple quotes (').
๐ How to use a different badge style
Note:
for-the-badge
is the style that we chose for appearance purposes. Other styles are available at https://shields.io/#styles and can be used with the badges here. Thanks, @kingthorin for mentioning this!
Shields.io offers 5 styles, which are:
S/N | Types | Styles |
---|---|---|
1 | Plastic | |
2 | Flat-square | |
3 | Flat | |
4 | Social | |
5 | For-the-badge |
๐ก To use a different style: Replace for-the-badge
in the markdown link with any of the styles above.
Example.
๐งท For plastic
https://shields.io/badge/style-plastic-green?logo=appveyor&style=plastic
๐ค๐ฝ For Flat
https://shields.io/badge/style-flat-green?logo=appveyor&style=flat
๐ Use Ctrl + F or CMD + F to search
Tip: Since there are a lot of badges, to search for the particular badge you are looking for, use Ctrl + F and type the name you want. Thanks, @JakyeRU for mentioning this!
The project has a separate contribution file. Please adhere to the steps listed in the separate contributions file
You can reach me on Twitter @ileriayooo
Name | Badge | Markdown |
---|---|---|
Hyperledger | ![Hyperledger](https://img.shields.io/badge/hyperledger-2F3134?style=for-the-badge&logo=hyperledger&logoColor=white) |
Name | Badge | Markdown |
---|---|---|
Octopus Deploy | ![Octopus Deploy](https://img.shields.io/badge/octopus%20deploy-0D80D8?style=for-the-badge&logo=octopusdeploy&logoColor=white) |
Name | Badge | Markdown |
---|---|---|
Qiskit | ![Qiskit](https://img.shields.io/badge/Qiskit-%236929C4.svg?style=for-the-badge&logo=Qiskit&logoColor=white) |
Name | Badge | Markdown |
---|---|---|
Fitbit | ![Fitbit](https://img.shields.io/badge/fitbit-00B0B9?style=for-the-badge&logo=fitbit&logoColor=white) |