Badges
Two ready-made badges let you show that a project runs on Miabi, or point readers at how to run it there.
| Badge | Use it for |
|---|---|
| Deploy on Miabi | The top of a README or a marketplace template, pointing readers at how to run your project on Miabi. |
| Running on Miabi | The footer of a site or app you host on Miabi. |
Variants
Each badge comes in four variants. Pick the one with enough contrast for where it sits:
| Variant | Background | Deploy on Miabi | Running on Miabi |
|---|---|---|---|
-dark | Light | ||
-light | Dark | ||
-white | Coloured or brand | ||
-purple | Any |
-purple is a filled gradient that stands out on any background, so use it when the badge is a
call to action. -white is transparent and single-colour.
Adding a badge
The badges are served from https://miabi.io/badges/<file>. Link them back to Miabi:
[](https://docs.miabi.io/docs/getting-started/quickstart?ref=badge)
[](https://miabi.io?ref=badge)
To follow the reader's light or dark theme, which GitHub supports, use a <picture> element:
<a href="https://miabi.io?ref=badge">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://miabi.io/badges/running-on-miabi-light.svg">
<img src="https://miabi.io/badges/running-on-miabi-dark.svg" alt="Running on Miabi" height="32">
</picture>
</a>
On a website, the same goes in the footer:
<a href="https://miabi.io?ref=badge" rel="noopener">
<img src="https://miabi.io/badges/running-on-miabi-dark.svg" alt="Running on Miabi" height="28">
</a>
The badges are vectors: set any height (24 to 40 px reads well) and the width follows. To serve
them yourself, download them from branding/badges
in the Miabi repository. All variants are on the preview page.
Guidelines
- Keep the link back to Miabi.
- Use the files as they are: don't recolour, redraw, stretch or crop them.
- Don't use a badge to suggest an endorsement or partnership with the Miabi project.
The Miabi logos, for articles, slides and integration docs, are in the same
branding folder, with their usage terms.