Page cover

🛠️Troubleshooting

There are a few reasons why your badge may not display correctly or at all. Below are a few things you can try in order to resolve your issue.

Sometimes, a simple refresh will do. If you are using a code editor, such as Visual Studio Code, try reopening the file, and the preview should update.

1. Syntax

You could have written the syntax wrong.

  • Missing Exclamation Mark - Ensure that the syntax starts with an exclamation mark ( ! ) for proper rendering.

  • Missing Brackets - You could be missing (square) brackets, or vice versa, you could have extra (square) brackets.

  • Typo - Make sure you haven't misspelt any part of the code that you may have changed wrong.

An example of correct syntax would be:

[![Docker](https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=fff)](https://www.docker.com)

If your logo is not showing, it may not be supported by Shields.io, which utilizes https://simpleicons.org, and its own little set of logo's here. If you can't find the logo you're looking for in either of these, Shields.io does not support your logo yet.

However, you can contribute to SimpleIcons and add the logo you are looking for (see their contributing guidelines first!).

3. Text

If you want to add spaces in between words inside of your badge, you need to use '%20'.

If you want to separate parts of your badge, you need to use - to separate the badge into 2 parts.

4. Platform Compatibility

In very specific cases, the platform you are trying to use the badges on may not support them.

In this case, the only thing you can do is use another platform.

Last updated

Was this helpful?