Back to skills
SKILL.md
096 Badges E885b78e
ASecurityThis document provides a comprehensive reference for badges commonly used in GitHub README files, particularly for educational and documentation projects.
- 9 stars
- 0 votes
- 0 copies
- 2 views
- Added October 11, 2026
Works with
Security analysis
100/100npx -y skills add tools-only/X-Skills --skill 096-badges_e885b78e --agent claude-codeAre you the author of 096 Badges E885b78e?
Add the live security badge to your README. It updates with every re-scan.
[](https://www.skillsdirectory.com/skills/tools-only-096-badges-e885b78e)# Badge Reference Guide
This document provides a comprehensive reference for badges commonly used in GitHub README files, particularly for educational and documentation projects.
## Badge Services
- **Shields.io**: https://shields.io/ - Most popular badge service
- **Badgen.net**: https://badgen.net/ - Alternative badge service
## Common Technology Badges
### Documentation Tools
**MkDocs**
```markdown
[](https://www.mkdocs.org/)
```
**Material for MkDocs**
```markdown
[](https://squidfunk.github.io/mkdocs-material/)
```
**Sphinx**
```markdown
[](https://www.sphinx-doc.org/)
```
### Programming Languages
**Python**
```markdown
[](https://www.python.org/)
```
**JavaScript**
```markdown
[](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
```
**TypeScript**
```markdown
[](https://www.typescriptlang.org/)
```
**Go**
```markdown
[](https://golang.org/)
```
**Rust**
```markdown
[](https://www.rust-lang.org/)
```
### Creative Coding & Visualization
**p5.js**
```markdown
[](https://p5js.org/)
```
**D3.js**
```markdown
[](https://d3js.org/)
```
**Chart.js**
```markdown
[](https://www.chartjs.org/)
```
**vis-network**
```markdown
[](https://visjs.org/)
```
**Mermaid**
```markdown
[](https://mermaid.js.org/)
```
### AI & Machine Learning
**Claude AI**
```markdown
[](https://claude.ai)
```
**Claude Code**
```markdown
[](https://claude.ai/code)
```
**Claude Skills**
```markdown
[](https://github.com/dmccreary/claude-skills)
```
**OpenAI**
```markdown
[](https://openai.com/)
```
**TensorFlow**
```markdown
[](https://www.tensorflow.org/)
```
**PyTorch**
```markdown
[](https://pytorch.org/)
```
### Hosting & Deployment
**GitHub Pages**
```markdown
[](SITE_URL)
```
**Netlify**
```markdown
[](https://www.netlify.com/)
```
**Vercel**
```markdown
[](https://vercel.com/)
```
### Repository & Version Control
**GitHub**
```markdown
[](REPO_URL)
```
**GitHub Stars**
```markdown
[](https://github.com/OWNER/REPO)
```
**GitHub Forks**
```markdown
[](https://github.com/OWNER/REPO)
```
**GitHub Issues**
```markdown
[](https://github.com/OWNER/REPO/issues)
```
**Last Commit**
```markdown
[](https://github.com/OWNER/REPO)
```
## License Badges
### Creative Commons
**CC BY 4.0**
```markdown
[](https://creativecommons.org/licenses/by/4.0/)
```
**CC BY-SA 4.0**
```markdown
[](https://creativecommons.org/licenses/by-sa/4.0/)
```
**CC BY-NC 4.0**
```markdown
[](https://creativecommons.org/licenses/by-nc/4.0/)
```
**CC BY-NC-SA 4.0** (Default for this project)
```markdown
[](https://creativecommons.org/licenses/by-nc-sa/4.0/)
```
**CC BY-ND 4.0**
```markdown
[](https://creativecommons.org/licenses/by-nd/4.0/)
```
**CC BY-NC-ND 4.0**
```markdown
[](https://creativecommons.org/licenses/by-nc-nd/4.0/)
```
**CC0 (Public Domain)**
```markdown
[](https://creativecommons.org/publicdomain/zero/1.0/)
```
### Open Source Licenses
**MIT**
```markdown
[](https://opensource.org/licenses/MIT)
```
**Apache 2.0**
```markdown
[](https://opensource.org/licenses/Apache-2.0)
```
**GPL-3.0**
```markdown
[](https://www.gnu.org/licenses/gpl-3.0)
```
**BSD 3-Clause**
```markdown
[](https://opensource.org/licenses/BSD-3-Clause)
```
**ISC**
```markdown
[](https://opensource.org/licenses/ISC)
```
## Status Badges
**Build Status**
```markdown
[](BUILD_URL)
```
**Coverage**
```markdown
[](COVERAGE_URL)
```
**Version**
```markdown
[](RELEASES_URL)
```
**Status**
```markdown
[](PROJECT_URL)
```
## Custom Badges
You can create custom badges using the Shields.io format:
```
https://img.shields.io/badge/{LABEL}-{MESSAGE}-{COLOR}
```
**Parameters:**
- `LABEL`: Left side text
- `MESSAGE`: Right side text
- `COLOR`: Badge color (name or hex without #)
**Optional parameters:**
- `?logo=LOGO_NAME`: Add icon from Simple Icons
- `&logoColor=COLOR`: Icon color
- `&style=STYLE`: Badge style (flat, flat-square, plastic, for-the-badge, social)
**Example custom badge:**
```markdown
[](URL)
```
## Badge Colors
Common color names supported by Shields.io:
- `brightgreen`
- `green`
- `yellowgreen`
- `yellow`
- `orange`
- `red`
- `blue`
- `lightgrey`
- `success`
- `important`
- `critical`
- `informational`
- `inactive`
Hex colors: Use without the `#` symbol (e.g., `FF6B6B`)
## Logo Names
Shields.io uses logos from [Simple Icons](https://simpleicons.org/). Common logo names:
- `python`
- `javascript`
- `typescript`
- `github`
- `gitlab`
- `visualstudiocode`
- `npm`
- `docker`
- `kubernetes`
- `react`
- `vue-dot-js`
- `angular`
- `node-dot-js`
- `postgresql`
- `mongodb`
- `redis`
## Best Practices
1. **Order badges logically**: Technology → Platform → Status → License
2. **Limit badge count**: 5-10 badges maximum for readability
3. **Keep labels concise**: Short, clear text
4. **Use consistent style**: Stick to one badge style (flat recommended)
5. **Ensure accessibility**: Use sufficient color contrast
6. **Link badges appropriately**: Link to relevant documentation or homepage
7. **Update dynamically**: Use dynamic badges (version, build status) when possible
## Example Badge Section
```markdown
[](https://www.mkdocs.org/)
[](https://squidfunk.github.io/mkdocs-material/)
[](https://username.github.io/repo-name)
[](https://github.com/username/repo-name)
[](https://claude.ai/code)
[](https://creativecommons.org/licenses/by-nc-sa/4.0/)
```
## Resources
- Shields.io: https://shields.io/
- Simple Icons: https://simpleicons.org/
- Badge Generator: https://shields.io/badges
- Markdown Guide: https://www.markdownguide.org/
Attribution
Comments
Loading comments…
Newsletter
Get the weekly list of safe new skills, and the ones we pulled.