Readme Badges#

These are example badges in Markdown that we typically put just below the header of the file of the repository. See for example jupyterhub/kubespawner. Most of the badges get the image representing the badge itself from


The badges is typically customized by passing query string parameters, to better understand these lets consider the most complicated badge in this list, the Helm chart badges.

The Helm chart badges are constructed on as a foundation along with a set of query strings.


In this case, the badge is customized to fetch json data from an URL and fetch the specific section in the json data as defined by the query. Here is the final result.$.jupyterhub.stable&colorB=orange&logo=helm

Note that we specified a color for this badge, often that is automatically assigned based on the the SemVer version, where something versioned 1.0.0 will become blue while something versioned 0.9.0 would be orange. This was not automatically determined for the Helm chart badge so it was explicitly specified.



Documentation build status

[![Documentation build status](](

CircleCI build status

[![CircleCI build status](](

TravisCI (.org) build status

[![TravisCI (.org) build status](](

TravisCI (.com) build status

[![TravisCI (.com) build status](](

AzurePipelines build status

[![AzurePipelines build status](](

DockerHub build status

[![DockerHub build status](](

Test coverage of code

[![Test coverage of code](](


Latest PyPI version

[![Latest PyPI version](](

Latest conda-forge version

[![Latest conda-forge version](](

Latest npm version

[![Latest npm version](](

Latest stable release of the Helm chart

[![Latest stable release of the Helm chart]($.jupyterhub.stable&colorB=orange&logo=helm)](

Latest pre-release of the Helm chart

[![Latest pre-release of the Helm chart]($.jupyterhub.pre&colorB=orange&logo=helm)](

Latest development release of the Helm chart

[![Latest development release of the Helm chart]($.jupyterhub.latest&colorB=orange&logo=helm)](