Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .mintlify-agent-context.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"schemaVersion": 1,
"sourceRepository": "mintlify/docs",
"sourcePath": "agent-context",
"sourceCommit": "1f43921f97dd5a4e51774d2753ef484d49694863",
"sourceCommit": "06341336d2beeed2d783317b1d4e9793124fa49a",
"target": "codex"
}
5 changes: 3 additions & 2 deletions skills/mintlify/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Read these files **only when your task requires them**. They are in the `referen

| File | When to read |
|------|-------------|
| `reference/components.md` | Adding or modifying components (callouts, cards, steps, tabs, accordions, code groups, fields, frames, icons, tooltips, badges, trees, mermaid, MDX, panels, prompts, colors, tiles, updates, views). |
| `reference/components.md` | Adding or modifying components (callouts, cards, steps, tabs, accordions, code groups, fields, frames, icons, tooltips, badges, trees, mermaid, MDX, panels, prompts, colors, tiles, updates, views). Also covers table column widths. |
| `reference/configuration.md` | Changing docs.json settings (theme, colors, logo, fonts, appearance, navbar, footer, banner, redirects, SEO, integrations, API config). Also covers snippets, hidden pages, .mintignore, custom CSS/JS, and the complete frontmatter fields table. |
| `reference/navigation.md` | Modifying site navigation structure (groups, tabs, anchors, dropdowns, products, versions, languages, OpenAPI, and SDK references in nav). |
| `reference/api-docs.md` | Setting up API documentation (OpenAPI, AsyncAPI, MDX manual API pages, extensions, playground config). |
Expand All @@ -39,7 +39,7 @@ Tools:

Write access to a Mintlify project. Requires OAuth on first use. Complete authentication in the browser when prompted.

Use this server when the user wants to edit their Mintlify content, restructure navigation, or open a pull request. All changes buffer on a session branch; nothing touches the deploy branch until `save`.
Use this server when the user wants to edit their Mintlify content, restructure navigation, or open a pull request. Content changes buffer on a session branch; nothing touches the deploy branch until `save`. Deployment management changes made through code mode apply immediately to the live deployment without a branch or pull request.

Workflow: call `checkout` first (always), then use `read`/`search`/`edit_page`/`write_page`/`list_nodes`/`create_node`/`update_node`/`move_node`/`delete_node`/`update_config` to make changes, then call `save` to publish (or `discard_session` to abandon).

Expand All @@ -51,6 +51,7 @@ Key tools:
- **`edit_page`** / **`write_page`** — Apply targeted edits or overwrite a page.
- **`list_nodes`** / **`create_node`** / **`update_node`** / **`move_node`** / **`delete_node`** — Manage the navigation tree.
- **`update_config`** — Modify `docs.json` (theme, nav roots, integrations, SEO).
- **`search_code_operations`** / **`execute_code`** — Code mode for deployment-level operations with no dedicated tool (workflows, settings, members, billing, integrations, analytics). Search available methods, then run a TypeScript script against them. No `checkout` required. Writes apply immediately to the live deployment, so confirm the intended change first.
- **`diff`** — See all changes relative to `main`.
- **`get_session_state`** — Check the current session's status.
- **`save`** — Publish the session. `mode: "auto"` (default) opens a PR, and Mintlify merges it immediately when the deployment's publishing setting allows direct pushes and the deploy branch isn't protected. `mode: "pr"` always opens a PR and leaves it open for review. `mode: "commit"` pushes to an existing PR branch without opening a new PR. Changing the publishing setting in the dashboard requires the admin role.
Expand Down
1 change: 1 addition & 0 deletions skills/mintlify/reference/api-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ For OpenAPI 3.1 specs, describe a file upload field as a string schema with a bi
- `x-hidden`: Creates page but hides from navigation.
- `x-excluded`: Completely excludes endpoint from docs.
- `x-codeSamples`: Custom code examples per endpoint.
- `x-mint.playground.expand`: Set to `false` on an operation to collapse nested object fields in the playground by default. Request sections (Authorization, Headers, Query, Path, Body) and the top-level body object stay expanded. Defaults to expanded when unset.

```yaml
paths:
Expand Down
30 changes: 29 additions & 1 deletion skills/mintlify/reference/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ Only the active branch renders on the page.
Notes:
- Block form at the top level of a page: leave a blank line after the opening tag so content parses as block-level Markdown.
- Inside expressions, `<MDX>` strips the common leading indentation from its content.
- Headings inside `<MDX>` do not appear in the page's table of contents.
- Headings inside `<MDX>` appear in the page's table of contents, including headings in branches that never render (such as the inactive side of a conditional).
- Limits: nest `<MDX>` up to 8 levels deep; a page can expand up to 500 `<MDX>` fragments inside expressions. Exceeding either limit fails the build.

## Panel
Expand Down Expand Up @@ -563,3 +563,31 @@ Embed a card that links to a public GitHub repository. The card fetches the repo
- `repo` (string, required): `owner/name` slug (for example, `mintlify/docs`) or a full GitHub URL.
- `variant` (string, default: `"inset"`): Card layout. Options: `inset`, `flat`.
- `className` (string): Additional CSS classes applied to the card.

## Table column widths

Markdown tables size columns automatically based on content. To control column widths, write the table in HTML and add a `<colgroup>` element that sets a width on every `<col>` (through the `width` attribute or an inline style). If any `<col>` is missing a width, Mintlify ignores the declared widths and sizes columns based on content. Tables too wide for the page scroll horizontally.

```html
<table>
<colgroup>
<col width="25%" />
<col width="15%" />
<col width="60%" />
</colgroup>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>string</td>
<td>Full name of the user</td>
</tr>
</tbody>
</table>
```