From 62c233e57f4df88f457bf7171113e700399be2c9 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 16 Oct 2025 21:14:13 +0000 Subject: [PATCH 1/5] Update settings/fonts.mdx --- settings/fonts.mdx | 151 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 settings/fonts.mdx diff --git a/settings/fonts.mdx b/settings/fonts.mdx new file mode 100644 index 000000000..dc5bd367a --- /dev/null +++ b/settings/fonts.mdx @@ -0,0 +1,151 @@ +--- +title: "Fonts" +description: "Configure custom fonts" +icon: "type" +--- + +Configure fonts for your entire site or separately for headings and body text. Use Google Fonts, local font files, or externally hosted fonts. The default font varies by theme. + +Fonts are controlled by the `fonts` property in your `docs.json`. + +## Google Fonts + +Mintlify automatically loads [Google Fonts](https://fonts.google.com) when you specify a font family name. + +```json +"fonts": { + "family": "Inter", + "weight": 400 +} +``` + +## Local fonts + +To use local fonts, place your font files in your project directory and reference them in your `docs.json` configuration. + +### Setting up local fonts + + + +For example, you can create a `fonts` directory and add your font files: + +``` +your-project/ +├── fonts/ +│ ├── InterDisplay-Regular.woff2 +│ └── InterDisplay-Bold.woff2 +├── docs.json +└── ... +``` + + + +Reference your local fonts using relative paths from your project root: + +```json docs.json +{ + "fonts": { + "family": "InterDisplay", + "source": "/fonts/InterDisplay-Regular.woff2", + "format": "woff2", + "weight": 400 + } +} +``` + + + +### Local fonts for headings and body + +You can configure separate local fonts for headings and body text: + +```json docs.json +{ + "fonts": { + "heading": { + "family": "InterDisplay", + "source": "/fonts/InterDisplay-Bold.woff2", + "format": "woff2", + "weight": 700 + }, + "body": { + "family": "InterDisplay", + "source": "/fonts/InterDisplay-Regular.woff2", + "format": "woff2", + "weight": 400 + } + } +} +``` + +### External font URLs + +You can also use external font URLs instead of local files: + +```json docs.json +{ + "fonts": { + "family": "Hubot Sans", + "source": "https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2", + "format": "woff2", + "weight": 400 + } +} +``` + +## Font configuration reference + + + Font configuration for your documentation. + + + + Font family name, such as "Inter" or "Playfair Display". + + + Font weight, such as 400 or 700. Variable fonts support precise weights such as 550. + + + URL to your font source, such as `https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2`, or path to your local font file, such as `/assets/fonts/InterDisplay.woff2`. Google Fonts are loaded automatically when you specify a Google Font `family` name, so no source URL is needed. + + + Font file format. Required when using the `source` field. + + + Override font settings specifically for headings. + + + + Font family name for headings. + + + Font weight for headings. + + + URL to your font source, such as `https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2`, or path to your local font file for headings. Google Fonts are loaded automatically when you specify a Google Font `family` name, so no source URL is needed. + + + Font file format for headings. Required when using the `source` field. + + + + + Override font settings specifically for body text. + + + + Font family name for body text. + + + Font weight for body text. + + + URL to your font source, such as `https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2`, or path to your local font file for body text. Google Fonts are loaded automatically when you specify a Google Font `family` name, so no source URL is needed. + + + Font file format for body text. Required when using the `source` field. + + + + + From 06bc79a805a1513fc0a92eb3870a8db969e6aa9c Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 16 Oct 2025 21:14:31 +0000 Subject: [PATCH 2/5] Update docs.json --- docs.json | 1 + 1 file changed, 1 insertion(+) diff --git a/docs.json b/docs.json index 6155db84c..2899d36de 100644 --- a/docs.json +++ b/docs.json @@ -67,6 +67,7 @@ "icon": "pen-line", "pages": [ "create/text", + "settings/fonts", "create/code", "create/image-embeds", "create/files", From 5877c826845a3bc7f19796fb33c806694ab44432 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 16 Oct 2025 16:00:12 -0700 Subject: [PATCH 3/5] update fonts info in docs.json --- organize/settings.mdx | 61 +++++++++++++++++++++++++++++++++++++++---- 1 file changed, 56 insertions(+), 5 deletions(-) diff --git a/organize/settings.mdx b/organize/settings.mdx index 1068005b9..065ab1f8b 100644 --- a/organize/settings.mdx +++ b/organize/settings.mdx @@ -189,20 +189,71 @@ This section contains the full reference for the `docs.json` file. - Font configuration for the headings in your documentation. The default font varies by theme. + Set custom fonts for your documentation. The default font varies by theme. - Font family, such as "Open Sans." + Font family, such as "Open Sans." [Google Fonts](https://fonts.google.com) family names are supported. - Font weight, such as 400 or 700. Variable fonts support precise weights such as 550. + Font weight, such as 400 or 700. Variable fonts support precise weights such as 550. - 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. + One of: + + - URL to a hosted font, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. + - Path to a local font file, such as `/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. - Font file format. + Font file format. Required when using the `source` field. + + + Override font settings specifically for headings. + + + + Font family, such as "Open Sans", "Playfair Display." [Google Fonts](https://fonts.google.com) family names are supported. + + + Font weight, such as 400, 700. Variable fonts support precise weights such as 550. + + + One of: + + - URL to a hosted font, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. + - Path to a local font file, such as `/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. + + + Font file format. Required when using the `source` field. + + + + + Override font settings specifically for body text. + + + + Font family, such as "Open Sans", "Playfair Display." [Google Fonts](https://fonts.google.com) family names are supported. + + + Font weight, such as 400, 700. Variable fonts support precise weights such as 550. + + + One of: + + - URL to a hosted font, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. + - Path to a local font file, such as `/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. + + + Font file format. Required when using the `source` field. + + From 272d5875f885b455f185a3217a72d88bca8de031 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 16 Oct 2025 16:07:43 -0700 Subject: [PATCH 4/5] move fonts file --- {settings => customize}/fonts.mdx | 0 docs.json | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename {settings => customize}/fonts.mdx (100%) diff --git a/settings/fonts.mdx b/customize/fonts.mdx similarity index 100% rename from settings/fonts.mdx rename to customize/fonts.mdx diff --git a/docs.json b/docs.json index 2899d36de..4fd21412b 100644 --- a/docs.json +++ b/docs.json @@ -49,6 +49,7 @@ "pages": [ "customize/custom-domain", "customize/themes", + "customize/fonts", "customize/custom-scripts", "customize/react-components", { @@ -67,7 +68,6 @@ "icon": "pen-line", "pages": [ "create/text", - "settings/fonts", "create/code", "create/image-embeds", "create/files", From 57504582a6d6b3daa24b9c18340b542d96f36b75 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 16 Oct 2025 16:13:49 -0700 Subject: [PATCH 5/5] copy edit --- customize/fonts.mdx | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/customize/fonts.mdx b/customize/fonts.mdx index dc5bd367a..9c4462802 100644 --- a/customize/fonts.mdx +++ b/customize/fonts.mdx @@ -1,21 +1,19 @@ --- title: "Fonts" description: "Configure custom fonts" -icon: "type" --- -Configure fonts for your entire site or separately for headings and body text. Use Google Fonts, local font files, or externally hosted fonts. The default font varies by theme. +Set a custom font for your entire site or separately for headings and body text. Use Google Fonts, local font files, or externally hosted fonts. The default font varies by theme. -Fonts are controlled by the `fonts` property in your `docs.json`. +Fonts are controlled by the [fonts property](/organize/settings#param-fonts) in your `docs.json`. ## Google Fonts -Mintlify automatically loads [Google Fonts](https://fonts.google.com) when you specify a font family name. +Mintlify automatically loads [Google Fonts](https://fonts.google.com) when you specify a font family name in your `docs.json`. -```json +```json docs.json "fonts": { - "family": "Inter", - "weight": 400 + "family": "Inter" } ``` @@ -27,9 +25,9 @@ To use local fonts, place your font files in your project directory and referenc -For example, you can create a `fonts` directory and add your font files: +For example, create a `fonts` directory and add your font files: -``` +```text your-project/ ├── fonts/ │ ├── InterDisplay-Regular.woff2 @@ -57,7 +55,7 @@ Reference your local fonts using relative paths from your project root: ### Local fonts for headings and body -You can configure separate local fonts for headings and body text: +Configure separate local fonts for headings and body text in your `docs.json`: ```json docs.json { @@ -78,9 +76,9 @@ You can configure separate local fonts for headings and body text: } ``` -### External font URLs +## Externally hosted fonts -You can also use external font URLs instead of local files: +Use externally hosted fonts by referencing a font source URL in your `docs.json`: ```json docs.json {