Badges - Docs

JSR provides badges for each package that can be used to showcase its latest version or its JSR score.

Version Badge

The version badge can be used to showcase the version of a package. It is available at the following URL:

https://jsr.io/badges/@<scope>/<package>

Here’s how it looks:

To include it in a Markdown document, use the following code, replacing <scope> and <package> with the actual scope and name of the package.

[![JSR](https://jsr.io/badges/@<scope>/<package>)](https://jsr.io/@<scope>/<package>)

In HTML documents, the following can be used:

<a href="https://jsr.io/@<scope>/<package>">
  <img src="https://jsr.io/badges/@<scope>/<package>" alt="" />
</a>

The JSR score badge can be used to showcase the JSR score of a package. It is available at the following URL:

https://jsr.io/badges/@<scope>/<package>/score

Here’s how it looks:

To include it in a Markdown document, use the following code, replacing <scope> and <package> with the actual scope and name of the package.

[![JSR Score](https://jsr.io/badges/@<scope>/<package>/score)](https://jsr.io/@<scope>/<package>)

In HTML documents, the following can be used:

<a href="https://jsr.io/@<scope>/<package>">
  <img src="https://jsr.io/badges/@<scope>/<package>/score" alt="" />
</a>

The scope badge can be used to showcase the package list of a scope. It is available at the following URL:

https://jsr.io/badges/@<scope>

Here’s how it looks:

To include it in a Markdown document, use the following code, replacing <scope> with the actual scope.

[![JSR Scope](https://jsr.io/badges/@<scope>)](https://jsr.io/@<scope>)

<a href="https://jsr.io/@<scope>">
  <img src="https://jsr.io/badges/@<scope>" alt="" />
</a>

These badges can be customized by adding query parameters to the URL, for example:

https://jsr.io/badges/@luca?logoColor=f7fd1e&color=f7fd1e&labelColor=083344

Here’s how it looks:

The supported style-related query parameters can be found in the Shields.io documentation.

Note: logoSize, logo, url, message and cacheSeconds are not supported and if provided, they will be ignored.