Skip to main content
Every example below is real MDX. Open the page’s View as Markdown option to copy any of it.

Callouts

A note adds extra context.
A tip shares a shortcut or best practice.
An info callout highlights helpful background.
A check confirms success.
A warning points out something to be careful about.
A danger callout flags something that can break things.

Cards

Plain card

A card with an icon and text.

Linked card

Add href and the whole card is clickable.

Card with CTA

Add cta for a custom link label.

Horizontal card

Use horizontal for a compact, full-width layout.

Columns

Left column

Columns arrange anything in a responsive grid.

Right column

They stack on small screens.

Steps

First step

Steps number a procedure automatically.
2

Second step

Put any content in a step, including code:
3

Third step

Done.

Tabs

Tabs switch between alternatives, like operating systems or languages.

Code groups and code blocks

highlight.py

Accordions

Accordions hide detail until a reader wants it.

Open by default

Set defaultOpen to start expanded.

Diagrams with Mermaid

Write a fenced mermaid block and Mintlify renders it, in light and dark mode. Flowcharts work the same way.

API fields

string
required
The ID of the user. Path parameters, query parameters, headers and body fields each have their own variant.
integer
default:"10"
Maximum number of results.
object
required
The user object.

Request and response examples

Frames and images

Mintlify Demo logo

An SVG image inside a Frame, with a caption.

Badges, tooltips and icons

Stable Beta Deprecated Outlined Pill Hover over to see a tooltip. Icons inline:

Tree

merge-sort-api
main.py
requirements.txt
docs
docs.json
index.mdx
openapi.json

Colors

primary

#0D9373

light

#55D799

surface

#F8FAFC

GitHub repo card

mintlify/docs
Loading repository data...

Prompt

Give this to your coding agent to write docs in your style.

Views

Math

Inline math like E=mc2E = mc^2 and block math: ∑i=1ni=n(n+1)2\sum_{i=1}^{n} i = \frac{n(n+1)}{2}

Tables and Markdown

Blockquotes, bold, italic, strikethrough, inline code and links all work as you’d expect.
  • Task lists
  • work too
Last modified on October 27, 2026