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
3 changes: 1 addition & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@
"api-playground/asyncapi/setup",
"api-playground/asyncapi/playground"
]

},
{
"group": "MDX",
Expand Down Expand Up @@ -390,5 +389,5 @@
"og:title": "Mintlify Docs",
"og:description": "Mintlify is a documentation platform that helps you create, manage, and share documentation for your projects."
}
}
}
}
45 changes: 45 additions & 0 deletions navigation/divisions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,49 @@ You can use any combination of anchors, tabs, and dropdowns - either one can be
}
```


```json Tabs with external anchors
{
"navigation": {
"tabs": [
{
"tab": "Tab 1",
"global": {
"anchors": [
{
"anchor": "Anchor 1",
"href": "https://mintlify.com/docs"
}
]
},
"groups": [
{
"group": "Group 1",
"pages": [
"some-folder/file-1",
"another-folder/file-2"
"just-a-file"
]
}
]
}
{
"tab": "Tab 2",
"groups": [
{
"group": "Group 2",
"pages": [
"some-other-folder/file-1",
"various-different-folders/file-2",
"another-file"
]
}
]
}
]
}
}
```


</CodeGroup>
82 changes: 66 additions & 16 deletions settings/global.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@

### Customization

<ResponseField name="theme" type='"mint" | "maple" | "palm"' required>
The layout theme of the project. Examples:
[Maple](https://maple.mintlify.app/), [Palm](https://palm.mintlify.app/),
<ResponseField name="theme" type='"mint" | "maple" | "palm" | "willow" | "linden"' required>
The layout theme of the project. Check out the [Themes](/themes) page for more information.
</ResponseField>

<ResponseField name="name" type="string" required>
Expand Down Expand Up @@ -96,7 +95,7 @@
The eyebrows style of the content. Defaults to `section`.
</ResponseField>
<ResponseField name="codeblocks" type="&quot;system&quot; | &quot;dark&quot;">
The codeblock theme. Defaults to `system`.

Check warning on line 98 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L98

Did you really mean 'codeblock'?
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -105,7 +104,7 @@
Icon library settings

<Expandable title="Icons">
<ResponseField name="library" type="&quot;fontawesome&quot;" required>
<ResponseField name="library" type="&quot;fontawesome&quot; | &quot;lucide&quot;" required>
The icon library to be used. Defaults to `fontawesome`.
</ResponseField>
</Expandable>
Expand All @@ -115,7 +114,7 @@

<Expandable title="Fonts">
<ResponseField name="family" type="string" required>
The font family, such as "Open Sans", "Playfair Display"

Check warning on line 117 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L117

Did you really mean 'Playfair'?
</ResponseField>
<ResponseField name="weight" type="number">
The font weight, such as 400, 700. Precise font weights such as 550 are supported for variable fonts.
Expand All @@ -124,7 +123,7 @@
The font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2
</ResponseField>
<ResponseField name="format" type="&quot;woff&quot; | &quot;woff2&quot;">
The font format, can be one of woff, woff2

Check warning on line 126 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L126

Did you really mean 'woff'?
</ResponseField>
<ResponseField name="heading" type="object">

Expand Down Expand Up @@ -169,7 +168,7 @@

<Expandable title="Appearance">
<ResponseField name="default" type="&quot;system&quot; | &quot;light&quot; | &quot;dark&quot;">
The default light/dark mode. Defaults to system
The default light/dark mode. Defaults to `system`
</ResponseField>
<ResponseField name="strict" type="boolean">
Whether to hide the light / dark mode toggle. Defaults to `true`.
Expand Down Expand Up @@ -236,9 +235,10 @@
<ResponseField name="type" type="&quot;button&quot; | &quot;github&quot;" required>
</ResponseField>
<ResponseField name="label" type="string" required>
The label for the primary button. This only applies when `type` is set to `button`.
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
A valid path or external link
A valid path or external link. If `type` is set to `github`, this will be the URL to the repository.
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -257,7 +257,7 @@
<ResponseField name="languages" type="array of object">

<Expandable title="Languages">
<ResponseField name="language" type="&quot;en&quot; | &quot;cn&quot; | &quot;es&quot; | &quot;fr&quot; | &quot;jp&quot; | &quot;pt&quot; | &quot;pt-BR&quot; | &quot;de&quot;" required>
<ResponseField name="language" type="&quot;en&quot; | &quot;cn&quot; | &quot;zh&quot; | &quot;zh-Hans&quot; | &quot;zh-Hant&quot; | &quot;es&quot; | &quot;fr&quot; | &quot;ja&quot; | &quot;jp&quot; | &quot;pt&quot; | &quot;pt-BR&quot; | &quot;de&quot; | &quot;ko&quot; | &quot;it&quot; | &quot;ru&quot; | &quot;id&quot; | &quot;ar&quot; | &quot;tr&quot;" required>
The name of the language in the ISO 639-1 format
</ResponseField>
<ResponseField name="default" type="boolean">
Expand Down Expand Up @@ -343,30 +343,54 @@
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField name="dropdowns" type="array of object">
<Expandable title="Dropdowns">
<ResponseField name="dropdown" type="string" required>
The name of the dropdown

Minimum length: 1
</ResponseField>
<ResponseField name="icon" type="string or object">
The icon to be displayed in the section
</ResponseField>
<ResponseField name="hidden" type="boolean">
Whether the current option is default hidden
</ResponseField>
<ResponseField name="href" type="string (uri)" required>
An external link
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="languages" type="array of object">
Organizing by languages
Organizing by [languages](/navigation/localization)

</ResponseField>
<ResponseField name="versions" type="array of object">
Organizing by versions
Organizing by [versions](/navigation/versions)

</ResponseField>
<ResponseField name="tabs" type="array of object">
Organizing by tabs
Organizing by [tabs](/navigation/divisions#tabs)

</ResponseField>
<ResponseField name="anchors" type="array of object">
Organizing by anchors
Organizing by [anchors](/navigation/divisions#anchors)

</ResponseField>

<ResponseField name="dropdowns" type="array of object">
Organizing by [dropdowns](/navigation/divisions#dropdowns)

</ResponseField>
<ResponseField name="groups" type="array of object">
Organizing by groups
Organizing by [groups](/navigation/pages#pages)

</ResponseField>
<ResponseField name="pages" type="array of string or object">
An array of page paths or groups
An array of [page paths or groups](/navigation/pages#groups)

</ResponseField>

Expand All @@ -385,7 +409,7 @@
}
```

Valid property names: bluesky, discord, facebook, github, hacker-news, instagram, linkedin, medium, podcast, reddit, slack, telegram, threads, twitter, website, x, youtube
Valid property names: `x`, `website`, `facebook`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`, `medium`, `telegram`, `twitter`, `x-twitter`, `earth-americas`, `bluesky`, `threads`, `reddit`, `podcast`
</ResponseField>
<ResponseField name="links" type="array of object">
The links to be displayed in the footer
Expand Down Expand Up @@ -448,7 +472,7 @@

<ResponseField name="contextual" type="object">
<Expandable title="Contextual">
<ResponseField name="options" type="('copy' | 'view' | 'chatgpt' | 'claude')[]" required>
<ResponseField name="options" type="array of &quot;copy&quot; | &quot;view&quot; | &quot;chatgpt&quot; | &quot;claude&quot;" required>
The options to be displayed in the contextual menu. The first option is the default option.
- `copy`: Copy the current page as markdown to the clipboard
- `view`: View the current page as markdown in a new tab
Expand All @@ -474,6 +498,19 @@
A string or an array of strings of absolute or relative urls pointing to the OpenAPI file(s)

<Expandable title="Openapi">
<ResponseField name="source" type="string">

Minimum length: 1
</ResponseField>
<ResponseField name="directory" type="string">
no starting slash in the directory
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="asyncapi" type="string or array or object">
A string or an array of strings of absolute or relative urls pointing to the AsyncAPI file(s)

<Expandable title="Asyncapi">
<ResponseField name="source" type="string">

Minimum length: 1
Expand Down Expand Up @@ -689,13 +726,26 @@
</Expandable>
</ResponseField>
<ResponseField name="segment" type="object">

<Expandable title="Segment">
<ResponseField name="key" type="string" required>
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField name="telemetry" type="object">
<Expandable title="Telemetry">
<ResponseField name="enabled" type="boolean">
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="cookies" type="object">
<Expandable title="Cookies">
<ResponseField name="key" type="string">
</ResponseField>
<ResponseField name="value" type="string">
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
</ResponseField>

Expand Down Expand Up @@ -1565,14 +1615,14 @@
"pages": ["analytics/posthog"]
}
],
"footerSocials": {

Check warning on line 1618 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L1618

Did you really mean 'footerSocials'?
"github": "https://github.com/mintlify",
"slack": "https://mintlify.com/community",
"x": "https://x.com/mintlify"
},
"integrations": {
"intercom": "APP_ID",
"frontchat": "CHAT_ID"

Check warning on line 1625 in settings/global.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/global.mdx#L1625

Did you really mean 'frontchat'?
}
}
```
Expand Down