Skip to Content

Badges

Small labels in the style of the organisation's badges.

A badge marks a kind, a version or a state in a few words. It looks like the badges the badge endpoint draws for the README files.

statein development versionv0.1 Aiviarium

MDX

<Badge label="state" value="in development" />
<Badge label="version" value="v0.1" icon={false} />
<Badge label="Aiviarium" />
PropUse
labelThe text on the dark field
valueThe text on the project colour. Without it, the label takes the colour
iconShows the project icon at the left. On by default

The style

PartValue
Height22 px
Radius5 px
Field#18181B with a 1 px #2A2A30 outline
LabelInter 600, #EDEDEF
ValueInter 650, #0A0A0B on the project colour

A badge is dark in both themes, like the images from the endpoint. It is the one place where the project colour fills an area.

Badges as images

The badges on the landing page are images from the endpoint at aiviarium-badges.helight.workers.dev. They are built from slug, repo and badges in docs.config.ts. Use the same addresses in the README:

[![Hatchery](https://aiviarium-badges.helight.workers.dev/hatchery?facet)](https://github.com/aiviarium/hatchery)
[![CI](https://aiviarium-badges.helight.workers.dev/hatchery/github/actions/workflow/status/aiviarium/hatchery/ci.yml?label=CI)](https://github.com/aiviarium/hatchery/actions/workflows/ci.yml)

See the badges repository for every address.

Edit on GitHub

Last updated on

On this page