Built-with badge
Add the "Built with superlore" badge to your README or docs — copy a Markdown, HTML, or React snippet in one click.
Shipped a knowledge base with superlore? Add the badge to your README. The default badge auto-adapts to light and dark — embedded as an image, it follows the viewer's color scheme.
Pick a theme
Prefer a fixed look? Use a dedicated variant instead of the auto badge. The path is relative to your
own deploy — on this site it's served from superlore.vercel.app.
- Auto (default) — follows the viewer's theme:
/built-with-superlore.svg - Light — for light backgrounds:
/built-with-superlore-light.svg - Dark — for dark backgrounds:
/built-with-superlore-dark.svg
Markdown
For a README or any Markdown file. Each block below has a copy button — grab one and paste.
[](https://superlore.vercel.app)Self-host the SVG
The badge lives at /built-with-superlore.svg on your own deploy too — swap the URL for your
site's origin (e.g. https://your-kb.com/built-with-superlore.svg) so the image is served from
the same place as your KB.
HTML
For a docs page, a website footer, or anywhere Markdown isn't an option.
<a href="https://superlore.vercel.app" target="_blank" rel="noreferrer">
<img
src="https://superlore.vercel.app/built-with-superlore.svg"
alt="Built with superlore"
height="28"
/>
</a>React (superlore)
Already inside a superlore app? The package ships the badge as a token-driven component — it tracks your theme (light and dark are co-equal) instead of loading a static image.
import { BuiltWithSuperlore } from "superlore";
export function Footer() {
return <BuiltWithSuperlore />;
}BuiltWithSuperlore links to the superlore project by default; pass href to point it elsewhere.