Skip to main content

Badges

Two ready-made badges let you show that a project runs on Miabi, or point readers at how to run it there.

BadgeUse it for
Deploy on MiabiThe top of a README or a marketplace template, pointing readers at how to run your project on Miabi.
Running on MiabiThe 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:

VariantBackgroundDeploy on MiabiRunning on Miabi
-darkLightDeploy on Miabi, darkRunning on Miabi, dark
-lightDarkDeploy on Miabi, lightRunning on Miabi, light
-whiteColoured or brandDeploy on Miabi, whiteRunning on Miabi, white
-purpleAnyDeploy on Miabi, purpleRunning on Miabi, purple

-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:

README.md
[![Deploy on Miabi](https://miabi.io/badges/deploy-on-miabi-purple.svg)](https://docs.miabi.io/docs/getting-started/quickstart?ref=badge)
README.md
[![Running on Miabi](https://miabi.io/badges/running-on-miabi-dark.svg)](https://miabi.io?ref=badge)

To follow the reader's light or dark theme, which GitHub supports, use a <picture> element:

README.md
<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:

footer.html
<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.