API Reference

Overview

The superlore component library — what each one is, when to use it, and how it looks.

Every component renders for humans and serializes to the MCP. Author once in MDX — every name below is registered in superlore's MDX component map, so you drop it into any .mdx and it renders. Components are tokens-only and light/dark co-equal — you never pick a colour or a size.

The primitives and editorial pieces give a page its shape and scannable spine. The structural components carry a typed knowledge face — an agent reads the data behind the picture, never the picture. Each one has its own page below.

Primitives

The Mintlify-compatible building blocks — emphasis, navigation, and layout. Inline and layout primitives are presentational by design and emit no knowledge node; callouts serialize a severity.

Editorial

The pieces that give a reference page its scannable spine. KeyFacts, StatGrid, and FeatureList also serialize to the knowledge face, so the facts at the top of a page are queryable, not just decorative.

Structural

The dual-representation differentiators — each renders a polished visual for humans and hands an agent the typed knowledge node behind it. This is the moat: one authored source, two faces.

Two faces, one source

The structural components carry a typed knowledge face — an agent reads the data behind the picture over the MCP. The primitives render for humans; callouts and the editorial pieces (KeyFacts, StatGrid, MetaBar, FeatureList) also serialize, but the inline and layout-only primitives intentionally emit no knowledge node, keeping the index free of presentational noise.

The full catalog

Every component, by category and when to reach for it.
ComponentCategoryWhen to use
CalloutEmphasisCall out a caveat, tip, or warning
Card / CardGroupNavigationLink to related pages as a grid
ColumnsLayoutPlace content side by side
StepsLayoutAn ordered procedure or runbook
TabsLayoutAlternative views of one thing (OS, language)
AccordionLayoutCollapsible detail or FAQ-style content
TreeLayoutShow a file or hierarchy structure
FrameMediaFrame an image or a preview tile
TileMediaA preview tile with a hatched backdrop
IconInlineAn inline lucide icon
BadgeInlineA Mintlify-compatible status chip
PillInlineThe editorial status chip
TooltipInlineA hover gloss on a term
KeyFactsEditorialLabel→value facts at the top of a reference
StatGridEditorialHeadline metrics
MetaBarEditorialAn inline strip of page metadata
FeatureListEditorialAn itemized feature or link list
TimelineStructuralDated, ordered events with status
EntityCardStructuralA typed thing with fields + relations
DataTableStructuralTyped columns + rows an agent can sort
CanvasRich vizA FigJam-style whiteboard / diagram from a spec

Canvas lives on its own

Canvas — the interactive, FigJam-style whiteboard — is a structural component too, but it's large enough to warrant its own top-level section. See Canvas for the shape library, sections, typed edges, and the agent-native superlore-canvas authoring block.

On this page

Built withsuperlore