Skip to main content

Documentation Index

Fetch the complete documentation index at: https://learn.mintlify.com/llms.txt

Use this file to discover all available pages before exploring further.

Inline links and cards are not interchangeable. Each carries a different implication about how important the destination is and how much the reader should interrupt their flow to follow it. Before adding a navigation element, ask how much attention the destination deserves. That answer determines the right component. An inline link is the default. Use it when:
  • The reference is contextual. The reader might want more detail, but continuing without following it is fine.
  • The destination is supplementary, not required.
  • The link appears within a sentence.
Mintlify uses the [Diátaxis framework](https://diataxis.fr) as a model for content types.
This is a hint, not a call to action. Most readers continue reading. Some open the link for context. The inline format correctly signals its optional nature. Inline links are also right for cross-references between closely related pages, citations, and anywhere the link is one of several possible paths forward. It’s not the primary next step.

​
Cards

A card is a call to action. Use it when:
  • There’s a clear next step and you want to make it prominent.
  • The destination is important enough to interrupt reading and draw attention.
  • You’re pointing to a page the reader should visit before continuing.
  • You’re at the end of a section or page and guiding the reader forward.
Cards are meant to capture attention. Readers generally notice cards but can skim past inline links. Use a card over an inline link when the destination is important enough that you want it visible even to readers who are skimming.
SituationComponent
Reference within proseInline link
Supplementary reading the user might wantInline link
Next step in a linear flowCard
Decision point with two to four optionsCards in columns
Next up: End-of-page navigation patterns — What to put at the bottom of a page to help readers continue naturally.