Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/sorgm/data-architecture-docs/llms.txt

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

Mintlify pages are written in MDX, a powerful extension of Markdown that lets you embed interactive components directly in your documentation.

​
Basic Markdown syntax

​
Headings

Use ## for section headers and ### for subsection headers. Each heading creates an anchor link and appears in the table of contents. 
## Section heading

### Subsection heading
Headings automatically generate URL anchors, so ## Getting Started creates an anchor at #getting-started that you can link to.

​
Text formatting

Format text using standard Markdown syntax:
StyleSyntaxResult
Bold**bold**bold
Italic_italic_italic
Strikethrough~strikethrough~strikethrough
Combine styles for emphasis: **_bold and italic_** renders as bold and italic. For superscript and subscript, use HTML tags:
StyleSyntaxResult
Superscript<sup>superscript</sup>superscript
Subscript<sub>subscript</sub>subscript

​
Lists

Create unordered lists with - or *: 
- First item
- Second item
  - Nested item
  - Another nested item
Create ordered lists with numbers: 
1. First step
2. Second step
3. Third step
Link to external sites: [Google](https://google.com) creates Google. Link to internal pages using root-relative paths: [Settings](/essentials/settings) links to Settings.
Avoid relative links like ../settings. Use root-relative paths like /essentials/settings for better performance and reliability.

​
Blockquotes

Create blockquotes with >:
Documentation is a love letter that you write to your future self. — Damian Conway 
> Documentation is a love letter that you write to your future self.
> 
> — Damian Conway

​
Mintlify components

MDX lets you use powerful React components in your documentation. Here are the most commonly used Mintlify components:

​
Callout components

Note

Use <Note> for helpful information

Tip

Use <Tip> for pro tips and best practices

Warning

Use <Warning> for important warnings

Info

Use <Info> for general information
Example usage:
This is a note callout. Use it to highlight helpful information that users should be aware of.
<Note>
This is a note callout. Use it to highlight helpful information.
</Note>

​
Card and CardGroup

Display content in cards for better visual organization:

Getting Started

Jump right in with our quickstart guide

API Reference

Explore our API endpoints

Guides

Learn best practices

Examples

See real-world examples
<CardGroup cols={2}>
  <Card title="Getting Started" icon="rocket" href="/quickstart">
    Jump right in with our quickstart guide
  </Card>
  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Explore our API endpoints
  </Card>
</CardGroup>

​
Accordion

Use accordions to hide detailed content until needed:
MDX is a format that lets you write JSX (React components) in your Markdown documents. This means you can import and use interactive components alongside your content.
Components make your documentation interactive and engaging. They help you present information in structured, scannable formats that improve the user experience.
Yes! You can create custom components in your snippets directory and import them into any page. See the Reusable Snippets guide for details.
<AccordionGroup>
  <Accordion title="What is MDX?">
    MDX is a format that lets you write JSX in your Markdown documents.
  </Accordion>
  <Accordion title="Why use components?">
    Components make your documentation interactive and engaging.
  </Accordion>
</AccordionGroup>

​
Tabs

Present alternative options or multi-language examples: 
npm install mintlify
Code: 
<Tabs>
  <Tab title="npm">
    npm install mintlify
  </Tab>
  <Tab title="yarn">
    yarn add mintlify
  </Tab>
</Tabs>

​
Steps

Guide users through sequential processes:
1

Install Mintlify

Install the Mintlify CLI to preview your documentation locally.
npm i -g mintlify
2

Navigate to your docs

Go to the directory where your documentation is located.
cd path/to/docs
3

Start the dev server

Preview your changes locally with hot reloading.
mintlify dev
Code: 
<Steps>
  <Step title="Install Mintlify">
    Install the CLI to preview docs locally.
  </Step>
  <Step title="Start dev server">
    Preview your changes with hot reloading.
  </Step>
</Steps>

​
Advanced features

​
LaTeX math

Render mathematical expressions using LaTeX with the <Latex> component: 
<Latex>E = mc^2</Latex>
You can also use inline math notation for complex formulas.

​
Tables

Create tables using standard Markdown syntax:
FeatureMarkdownMDXMintlify
Basic formatting✓✓✓
Components✗✓✓
Syntax highlighting✗✗✓
Auto-generated nav✗✗✓
| Feature | Markdown | MDX | Mintlify |
| ------- | -------- | --- | -------- |
| Basic formatting | ✓ | ✓ | ✓ |
| Components | ✗ | ✓ | ✓ |
Explore more components in the Mintlify documentation to enhance your docs.

Build docs developers (and LLMs) love

Get started for freeTalk to us