> ## Documentation Index
> Fetch the complete documentation index at: https://docs.marcodewey.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Component tour

> A tour of the components you can use on any Mintlify page.

Every example below is real MDX. Open the page's **View as Markdown** option to copy any of it.

## Callouts

> [!NOTE]
>
> A **note** adds extra context.

> [!TIP]
>
> A **tip** shares a shortcut or best practice.

> [!NOTE]
>
> An **info** callout highlights helpful background.

> [!TIP]
>
> A **check** confirms success.

> [!WARNING]
>
> A **warning** points out something to be careful about.

> [!CAUTION]
>
> A **danger** callout flags something that can break things.

## Cards

> [card] Plain card
>
> A card with an icon and text.

> [card] [Linked card](https://docs.marcodewey.com/quickstart.md)
>
> Add `href` and the whole card is clickable.

> [card] [Card with CTA](https://docs.marcodewey.com/changelog.md)
>
> Add `cta` for a custom link label.

> [card] Horizontal card
>
> Use `horizontal` for a compact, full-width layout.

## Columns

> [card] Left column
>
> Columns arrange anything in a responsive grid.

> [card] Right column
>
> They stack on small screens.

## Steps

**1. First step**

Steps number a procedure automatically.

**2. Second step**

Put any content in a step, including code:

```bash theme={null}
echo "hello from a step"
```

**3. Third step**

Done.

## Tabs

> [tab] First tab
>
> Tabs switch between alternatives, like operating systems or languages.

> [tab] Second tab
>
> Readers' choice is remembered across pages that use the same tab titles.

## Code groups and code blocks

```python Python theme={null}
def greet(name: str) -> str:
    return f"Hello, {name}!"
```

```javascript JavaScript theme={null}
const greet = (name) => `Hello, ${name}!`;
```

```go Go theme={null}
func greet(name string) string { return "Hello, " + name + "!" }
```

```python title="highlight.py" lines highlight={2,3} theme={null}
def total(items):
    subtotal = sum(items)       # highlighted
    return subtotal * 1.08      # highlighted
```

## Accordions

> [accordion] Closed by default
>
> Accordions hide detail until a reader wants it.

> [accordion] 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.

```mermaid theme={null}
sequenceDiagram
    participant Reader
    participant Docs as Mintlify docs
    participant API as Your API
    Reader->>Docs: Opens an endpoint page
    Docs->>Reader: Shows request builder and code samples
    Reader->>API: Clicks "Try it"
    API-->>Reader: 200 OK with JSON
```

Flowcharts work the same way.

```mermaid theme={null}
flowchart LR
    Idea --> Draft --> Review --> Publish
    Review -- changes requested --> Draft
```

## API fields

**user\_id** `string` *required*

The ID of the user. Path parameters, query parameters, headers and body fields each have their own variant.

**limit** `integer` (default: 10)

Maximum number of results.

**user** `object` *required*

The user object.

**properties**

**name** `string`

The user's name.

**plan** `string` (default: free)

The user's plan.

## Request and response examples

```bash Request theme={null}
curl https://api.example.com/users/42
```

```json Response theme={null}
{ "user": { "name": "Ada", "plan": "free" } }
```

## Frames and images

![Mintlify Demo logo](https://mintcdn.com/mintlify-demo/ftr7TwW1rIS6Qhdf/logo/light.svg?fit=max\&auto=format\&n=ftr7TwW1rIS6Qhdf\&q=85\&s=62ba26dbb685fbe98c75fe4055da1835)

An SVG image inside a Frame, with a caption.

## Badges, tooltips and icons

StableBetaDeprecatedOutlinedPill

Hover over OpenAPI (A standard format for describing HTTP APIs. Mintlify turns it into an interactive API reference.) to see a tooltip.

Icons inline:  &#x20;

## Tree

**merge-sort-api**

**main.py**

**requirements.txt**

**tests**

**test\_main.py**

**docs**

**docs.json**

**index.mdx**

**openapi.json**

## Colors

**primary** `#0D9373`

**light** `#55D799`

**surface** `#F8FAFC` (light), `#0F172A` (dark)

## GitHub repo card

## Prompt

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

You are a technical writer. Write clear, concise documentation for developers.

* Use second person ("you") and active verbs.
* Start every procedure with a goal-oriented heading.
* Show a runnable code example for every endpoint.

## Views

**Python**

```python theme={null}
print("Views switch the content for the whole page.")
```

**JavaScript**

```javascript theme={null}
console.log("Pick a language and the page changes.");
```

## Math

Inline math like $E = mc^2$ and block math:

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

## Tables and Markdown

| Feature | Free | Pro | Enterprise |
| - | :-: | :-: | :-: |
| Docs hosting | Yes | Yes | Yes |
| AI assistant | | Yes | Yes |
| Multi-repo projects | | | Yes |

> Blockquotes, **bold**, *italic*, ~~strikethrough~~, `inline code` and [links](https://docs.marcodewey.com/quickstart.md) all work as you'd expect.

* [x] Task lists
* [ ] work too

> [!NOTE]
>
> A **Panel** pins content to the right-hand side of the page. Use it for examples, summaries or links.
