Skip to content
Merged
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
4 changes: 2 additions & 2 deletions settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

To get started, you only need to specify `theme`, `name`, `colors.primary`, and `navigation`. Other fields are optional and you can add them as your documentation needs grow.

For the best editing experience, include the schema reference at the top of your `docs.json` file. This enables autocomplete, validation, and helpful tooltips in most code editors:

Check warning on line 16 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L16

Did you really mean 'tooltips'?

```json
{
Expand Down Expand Up @@ -66,12 +66,12 @@
Must be a hex code beginning with `#`.
</ResponseField>
<ResponseField name="light" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
Primary color variant for light mode.
Light color variant of your theme.

Must be a hex code beginning with `#`.
</ResponseField>
<ResponseField name="dark" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
Primary color variant for dark mode.
Dark color variant of your theme.

Must be a hex code beginning with `#`.
</ResponseField>
Expand Down Expand Up @@ -145,7 +145,7 @@

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

Check warning on line 148 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L148

Did you really mean 'Playfair'?
</ResponseField>
<ResponseField name="weight" type="number">
Font weight, such as 400 or 700. Variable fonts support precise weights such as 550.
Expand Down Expand Up @@ -250,12 +250,12 @@

### Structure

<ResponseField name="navbar" type="object">

Check warning on line 253 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L253

Did you really mean 'navbar'?
Navigation bar items.

<Expandable title="Navbar">
<ResponseField name="links" type="array of object">
Links to display in the navbar

Check warning on line 258 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L258

Did you really mean 'navbar'?

<Expandable title="Links">
<ResponseField name="label" type="string" required>
Expand Down Expand Up @@ -293,7 +293,7 @@

<Expandable title="Navigation">
<ResponseField name="global" type="object">
Global navigation elements that appear accross all pages and sections.

Check warning on line 296 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L296

Did you really mean 'accross'?

<Expandable title="Global">
<ResponseField name="languages" type="array of object">
Expand Down Expand Up @@ -527,7 +527,7 @@
Contextual menu for AI-optimized content and integrations.

<Expandable title="Contextual">
<ResponseField name="options" type="array of &quot;copy&quot; | &quot;view&quot; | &quot;chatgpt&quot; | &quot;claude&quot;" required>

Check warning on line 530 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L530

Did you really mean 'chatgpt'?

Check warning on line 530 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L530

Did you really mean 'claude'?
Actions available in the contextual menu. The first option appears as the default.
- `copy`: Copy the current page as Markdown to the clipboard.
- `view`: View the current page as Markdown in a new tab.
Expand All @@ -546,7 +546,7 @@

### API Configurations

<ResponseField name="api" type="object">

Check warning on line 549 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L549

Did you really mean 'api'?
API documentation and interactive playground settings.

<Expandable title="Api">
Expand Down Expand Up @@ -965,7 +965,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 968 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L968

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1008,7 +1008,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1011 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1011

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1017,8 +1017,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1020 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1020

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1021 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1021

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down Expand Up @@ -1139,7 +1139,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 1142 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1142

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1182,7 +1182,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1185 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1185

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1191,8 +1191,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1194 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1194

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1195 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1195

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down Expand Up @@ -1277,10 +1277,10 @@
{
"dropdown": "Documentación",
"icon": "book",
"description": "Cómo usar el producto de Example Co.",

Check warning on line 1280 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1280

Did you really mean 'usar'?

Check warning on line 1280 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1280

Did you really mean 'producto'?
"pages": [
{
"group": "Comenzando",

Check warning on line 1283 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1283

Did you really mean 'Comenzando'?
"pages": ["es/index", "es/quickstart"]
},
{
Expand All @@ -1300,7 +1300,7 @@
{
"dropdown": "Changelog",
"icon": "history",
"description": "Actualizaciones y cambios",

Check warning on line 1303 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1303

Did you really mean 'Actualizaciones'?

Check warning on line 1303 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1303

Did you really mean 'cambios'?
"pages": ["es/changelog"]
}
]
Expand Down Expand Up @@ -1328,7 +1328,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 1331 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1331

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1371,7 +1371,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1374 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1374

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1380,8 +1380,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1383 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1383

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1384 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1384

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down