Tangly v0.2 ships richer code blocks, page chrome, and more — see what's new

Components

MDX components shipped with Tangly. Overview and per-page reference links.

~ 1 min read

Components

Every built-in component is auto-injected into MDX. No imports required. Prop signatures match Mintlify exactly, so existing content renders unchanged.

For full prop reference per component, see the Components reference.

Quick tour

Callouts

md
<Note>Heads up.</Note>
<Tip>Pro tip.</Tip>
<Warning>Watch out.</Warning>

Cards

With href

Click-through card with icon.

No href

Plain card, no link.

Tabs

bash
bun x tangly dev
bash
npx tangly dev

Steps

  1. One

    First step.
  2. Two

    Second step.
  3. Three

    Third step.

Accordion

Question one
Answer one.
Question two
Answer two.

API rows

user_id string path required

The user’s UUID.

email string

The user’s email address.

All components

ComponentReference page
Note, Tip, Warning, Info, Check, Danger, UpdateCallouts
Card, CardGroup, ColumnsCards
CodeGroup, PackageManager, Snippet, FileTree, KbdCode
Tabs, Tab, Steps, StepTabs & Steps
Frame, Accordion, AccordionGroup, ExpandableLayout
ParamField, ResponseField, RequestExample, ResponseExample, OpenApiEndpoint, OpenApiScalar, OpenApiRedoc, OpenApiStoplightAPI
Embed, Video, LightboxImageMedia
Badge, Icon, Tooltip, GlossaryTermText

Markdown extras

Some MDX features are syntax, not components. They’re wired by default and need no imports.

FeatureReference
LaTeX / KaTeX math ($…$, $$…$$, <latex>)Markdown · LaTeX
Mermaid diagrams (mermaid fenced block)Markdown · Mermaid

Customizing

Override any component by shadowing: drop a file at <userRoot>/components/<Name>.{astro,tsx} and Vite resolves your version everywhere it’s used.

For new components that aren’t in the built-in set, import them explicitly in your MDX:

md
import Tldr from "../components/Tldr.astro";

<Tldr>Short summary.</Tldr>

Auto-registration via tangly.config.ts is on the roadmap but not yet wired.

Last updated Edit this page

Type to search…

↑↓ navigate open esc close