Skip to content

Update information about fonts #880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 3, 2025
Merged

Update information about fonts #880

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
008f7ce
specify Inter is default font
ethanpalm Jul 3, 2025
68b246a
google fonts load automatically
ethanpalm Jul 3, 2025
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
14 changes: 7 additions & 7 deletions settings.mdx
View file
Open in desktop
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 @@ -154,17 +154,17 @@
</ResponseField>

<ResponseField name="fonts" type="object">
Font configuration for your documentation.
Font configuration for your documentation. The default font is [Inter](https://fonts.google.com/specimen/Inter).

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

Check warning on line 161 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L161 

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.
</ResponseField>
<ResponseField name="source" type="string (uri)">
URL to your font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2.
URL to your font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) are loaded automatically when you specify a Google Font `family` name, so no source URL is needed.
</ResponseField>
<ResponseField name="format" type="&quot;woff&quot; | &quot;woff2&quot;">
Font file format.
Expand All @@ -174,13 +174,13 @@

<Expandable title="Heading">
<ResponseField name="family" type="string" required>
Font family, such as "Open Sans", "Playfair Display"
Font family, such as "Open Sans", "Playfair Display."
</ResponseField>
<ResponseField name="weight" type="number">
Font weight, such as 400, 700. Variable fonts support precise weights such as 550.
</ResponseField>
<ResponseField name="source" type="string (uri)">
URL to your font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2.
URL to your font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) are loaded automatically when you specify a Google Font `family` name, so no source URL is needed.
</ResponseField>
<ResponseField name="format" type="&quot;woff&quot; | &quot;woff2&quot;">
Font file format.
Expand All @@ -192,13 +192,13 @@

<Expandable title="Body">
<ResponseField name="family" type="string" required>
Font family, such as "Open Sans", "Playfair Display"
Font family, such as "Open Sans", "Playfair Display."
</ResponseField>
<ResponseField name="weight" type="number">
Font weight, such as 400, 700. Variable fonts support precise weights such as 550.
</ResponseField>
<ResponseField name="source" type="string (uri)">
URL to your font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2.
URL to your font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) are loaded automatically when you specify a Google Font `family` name, so no source URL is needed.
</ResponseField>
<ResponseField name="format" type="&quot;woff&quot; | &quot;woff2&quot;">
Font file format.
Expand Down Expand Up @@ -263,12 +263,12 @@

### Structure

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

Check warning on line 266 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L266 

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 271 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L271 

Did you really mean 'navbar'?

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

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

Check warning on line 309 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L309 

Did you really mean 'accross'?

<Expandable title="Global">
<ResponseField name="languages" type="array of object">
Expand Down Expand Up @@ -540,7 +540,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 543 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L543 

Did you really mean 'chatgpt'?

Check warning on line 543 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L543 

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 @@ -559,7 +559,7 @@

### API Configurations

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

Check warning on line 562 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L562 

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

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

Check warning on line 981 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L981 

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

Check warning on line 1024 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1024 

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

Check warning on line 1033 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1033 

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

Check warning on line 1034 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1034 

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

Check warning on line 1155 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1155 

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

Check warning on line 1198 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1198 

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

Check warning on line 1207 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1207 

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

Check warning on line 1208 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1208 

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

Check warning on line 1293 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1293 

Did you really mean 'usar'?

Check warning on line 1293 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1293 

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

Check warning on line 1296 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1296 

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

Check warning on line 1316 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1316 

Did you really mean 'Actualizaciones'?

Check warning on line 1316 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1316 

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

Check warning on line 1344 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1344 

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

Check warning on line 1387 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1387 

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

Check warning on line 1396 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1396 

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

Check warning on line 1397 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1397 

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