Callouts
A note adds extra context.
An info callout highlights helpful background.
A check confirms success.
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
- First tab
- Second tab
Tabs switch between alternatives, like operating systems or languages.
Code groups and code blocks
highlight.py
Accordions
Closed by default
Closed by default
Accordions hide detail until a reader wants it.
Open by default
Open by default
Set
defaultOpen to start expanded.Diagrams with Mermaid
Write a fencedmermaid block and Mintlify renders it, in light and dark mode.
Flowcharts work the same way.
API fields
The ID of the user. Path parameters, query parameters, headers and body fields each have their own variant.
Request and response examples
Frames and images
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
tests
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 and block math:Tables and Markdown
Blockquotes, bold, italic,strikethrough,inline codeand links all work as you’d expect.
- Task lists
- work too