From 670831bb63ebc06c33b6315473f8e2ba42ce5746 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 9 Jan 2026 16:49:18 +0000 Subject: [PATCH] Documentation edits made through Mintlify web editor --- organize/settings.mdx | 40 ++++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/organize/settings.mdx b/organize/settings.mdx index ef9e30f72..9f2ef52cb 100644 --- a/organize/settings.mdx +++ b/organize/settings.mdx @@ -1,7 +1,7 @@ --- title: "Global settings" description: "Configure site-wide settings in docs.json." -keywords: ["docs.json", "settings", "customization", "configuration", "logo", "colors", "fonts", "background", "appearance", "last modified date", "timestamp"] +keywords: ["docs.json","settings","customization","configuration","logo","colors","fonts","background","appearance","last modified date","timestamp"] --- import IconsOptional from "/snippets/icons-optional.mdx"; @@ -10,6 +10,8 @@ The `docs.json` file lets you turn a collection of Markdown files into a navigab Settings in `docs.json` apply globally to all pages. +### daniel is cool + ## Setting up your `docs.json` 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. @@ -135,7 +137,7 @@ This section contains the full reference for the `docs.json` file. Controls whether LaTeX stylesheets are included, overriding automatic detection. By default, Mintlify automatically detects LaTeX usage in your content and loads the necessary stylesheets. - + - Set to `true` to force-load LaTeX stylesheets when automatic detection fails to recognize your mathematical expressions. - Set to `false` to prevent loading LaTeX stylesheets for improved performance if you don't use mathematical expressions but have content that triggers false-positive detection. @@ -217,7 +219,7 @@ This section contains the full reference for the `docs.json` file. Icon library to use throughout your documentation. Defaults to `fontawesome`. - You can only use one icon library for your project. All icon names in your documentation must come from the same library. + You can only use one icon library for your project. All icon names in your documentation must come from the same library. You can specify a URL to an externally hosted icon, path to an icon file in your project, or JSX-compatible SVG code for any individual icon, regardless of the library setting. @@ -238,10 +240,10 @@ This section contains the full reference for the `docs.json` file. 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. @@ -259,13 +261,13 @@ This section contains the full reference for the `docs.json` file. 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. @@ -282,13 +284,13 @@ This section contains the full reference for the `docs.json` file. 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. @@ -675,12 +677,12 @@ This section contains the full reference for the `docs.json` file. Link destination for the custom option. Can be a simple URL string or an object with `base` and optional `query` parameters. Placeholder values: + - `$page`: Current page content - `$path`: Current page path - `$mcp`: MCP server URL - Contextual Menu - + ```json Single file "openapi": "openapi.json" ``` + ```json Multiple files "openapi": [ "openapi/v1.json", @@ -729,12 +732,14 @@ This section contains the full reference for the `docs.json` file. ] ``` + ```json Directory "openapi": { "source": "openapi.json", "directory": "api-docs" } ``` + @@ -752,12 +757,13 @@ This section contains the full reference for the `docs.json` file. Do not include a leading slash. - + ```json Single file "asyncapi": "asyncapi.json" ``` + ```json Multiple files "asyncapi": [ "asyncapi/events.yaml", @@ -766,14 +772,15 @@ This section contains the full reference for the `docs.json` file. ] ``` + ```json Directory "asyncapi": { "source": "asyncapi.json", "directory": "websockets" } ``` - + Display settings for API parameters. @@ -802,6 +809,7 @@ This section contains the full reference for the `docs.json` file. Example languages for the autogenerated API snippets. Supported languages include: + - `bash` (displayed as cURL) - `go` - `java` @@ -1068,7 +1076,7 @@ This section contains the full reference for the `docs.json` file. Whether to enable telemetry. - + When set to `false`, feedback features are also disabled and do not appear on your documentation pages.