From 849a43911303f9b3563010646f91829354b59a8c Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 15 Nov 2024 22:44:39 +0000 Subject: [PATCH 1/2] Documentation edits made through Mintlify web editor --- settings/global.mdx | 560 +++++++++++++++++++++++--------------------- 1 file changed, 296 insertions(+), 264 deletions(-) diff --git a/settings/global.mdx b/settings/global.mdx index 285e2528a..d2399e7ff 100644 --- a/settings/global.mdx +++ b/settings/global.mdx @@ -20,13 +20,16 @@ settings. Learn more about the [properties](#properties) or from an Path to logo image or object with path to "light" and "dark" mode logo images, and where the logo links to. SVG format is recommended. It does not pixelate and the file size is generally smaller. + Path to the logo in light mode. For example: `/path/to/logo.svg` + Path to the logo in dark mode. For example: `/path/to/logo.svg` + Where clicking on the logo links you to @@ -39,24 +42,30 @@ settings. Learn more about the [properties](#properties) or from an Hex color codes for your global theme + The primary color. Used most often for highlighted content, section headers, accents, in light mode + The primary color for dark mode. Used most often for highlighted content, section headers, accents, in dark mode + The primary color for important buttons + The color of the background in both light and dark mode + The hex color code of the background in light mode + The hex color code of the background in dark mode @@ -73,16 +82,13 @@ settings. Learn more about the [properties](#properties) or from an [Prism](https://starter-prism.mintlify.app) - + The global layout style of the documentation. Set a decorative background. + The style of the decorative background. @@ -97,24 +103,24 @@ settings. Learn more about the [properties](#properties) or from an Custom fonts. Apply globally or set different fonts for headings and the body text. -Example: + Example: -```json -"font": { - "headings": { - "family": "Roboto" - }, - "body": { - "family": "Oswald" + ```json + "font": { + "headings": { + "family": "Roboto" + }, + "body": { + "family": "Oswald" + } } -} -``` + ``` @@ -122,15 +128,18 @@ Example: Fonts](https://fonts.google.com/) are supported. e.g. "Open Sans", "Playfair Display" + The font weight. Precise values such as `560` are also supported for variable fonts. Check under the Styles section for your Google Font for the available weights. + The URL to the font file. Can be used to specify a font that is not from Google Fonts. + The font format. Required if using a custom font source (`url`). @@ -139,43 +148,40 @@ Example: Customize the dark mode toggle. + Set if you always want to show light or dark mode for new users. When not set, we default to the same mode as the user's operating system. + Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example: - - -```json Only Dark Mode -"modeToggle": { - "default": "dark", - "isHidden": true -} -``` - -```json Only Light Mode -"modeToggle": { - "default": "light", - "isHidden": true -} -``` + + ```json Only Dark Mode + "modeToggle": { + "default": "dark", + "isHidden": true + } + ``` + + ```json Only Light Mode + "modeToggle": { + "default": "light", + "isHidden": true + } + ``` - Customize the styling of components within the sidebar. + - + The styling of the navigation item. @@ -183,12 +189,9 @@ Example: Styling configurations for the topbar. + - + The styling of the navigation item. @@ -196,6 +199,7 @@ Example: The location options for the search bar. + The location of the search bar. @@ -209,6 +213,7 @@ Example: The style of the code block. + `auto` will automatically switch between light and dark mode based on the @@ -221,37 +226,37 @@ Example: An array of groups with all the pages within that group + - The name of the group. - + The name of the group. - - The relative paths to the markdown files that will serve as pages. Note: groups are recursive, so to add a sub-folder add another group object in the page array. + + The relative paths to the markdown files that will serve as pages. Note: groups are recursive, so to add a sub-folder add another group object in the page array. - - The [Fontawesome](https://fontawesome.com/icons) icon for the group. Note: this only applies to sub-folders. + + The [Fontawesome](https://fontawesome.com/icons) icon for the group. Note: this only applies to sub-folders. - - The type of [Fontawesome](https://fontawesome.com/icons) icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin + + The type of [Fontawesome](https://fontawesome.com/icons) icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin - Array of names and urls of links you want to include in the topbar + The name of the button. + The url once you click on the button. Example: `https://mintlify.com/contact` - @@ -261,16 +266,20 @@ Example: Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars. + If type is a link: What the button links to. If type is a github: Link to the repository to load GitHub information from. + Text inside the button. Only required if type is a link. + The style of the button. + Whether to display the arrow @@ -281,95 +290,106 @@ Example: Array of version names. Only use this if you want to show different versions of docs with a dropdown in the navigation bar. -Versions can be leveraged for localization. You can store translated content -under a version, and once you specify the `locale` any fixed text in Mintlify, -such as 'Was this page helpful?', will automatically be translated based on the -locale. We currently support localization in English, Chinese, Spanish, French, -Japanese, and Portuguese. + Versions can be leveraged for localization. You can store translated content + under a version, and once you specify the `locale` any fixed text in Mintlify, + such as 'Was this page helpful?', will automatically be translated based on the + locale. We currently support localization in English, Chinese, Spanish, French, + Japanese, Portuguese, and German. -For more information, please refer to our -[versioning documentation](/settings/versioning). + For more information, please refer to our + [versioning documentation](/settings/versioning). - Example: - + Example: -```json Default -"versions": ["v1.0", "v1.1"] -``` + + ```json Default + "versions": ["v1.0", "v1.1"] + ``` + + ```json Localization + "versions": [ + { + "name": "English", + "locale": "en", + }, + { + "name": "Español", + "locale": "es" + } + ] + ``` + -```json Localization -"versions": [ - { - "name": "English", - "locale": "en", - }, - { - "name": "Español", - "locale": "es" - } -] -``` - - - - - - The version name. - - - The locale of the version. Supported locales are `en`, `cn`, `es`, `fr`, `jp`, `pt`, `pt-BR`. - - - Whether the version is the default version. Handy for when you have a "latest" and "stable" version and you want to default to the stable version. - - + + + The version name. + + + + The locale of the version. Supported locales are `en`, `cn`, `es`, `fr`, `jp`, `pt`, `pt-BR`. + + + Whether the version is the default version. Handy for when you have a "latest" and "stable" version and you want to default to the stable version. + + An array of the anchors, includes the icon, color, and url. + + + - The name of the anchor label. + The name of the anchor label. - Example: `Community` + Example: `Community` + - The [Font Awesome](https://fontawesome.com/search?q=heart) icon used to feature the anchor. + The [Font Awesome](https://fontawesome.com/search?q=heart) icon used to feature the anchor. - Example: `comments` + Example: `comments` + The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in. + The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `from` and `to` that are each a hex color. + Used if you want to hide an anchor until the correct docs version is selected. + Pass `true` if you want to hide the anchor until you directly link someone to docs inside it. + One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin" - Override the default configurations for the top-most anchor. Note: if you have tabs configured, this does not apply. + The name of the top-most anchor + Font Awesome icon. + One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin" @@ -379,29 +399,31 @@ For more information, please refer to our An array of navigational tabs. -Example: + Example: -```json -"tabs": [ - { - "name": "Writing Content", - "url": "content" - }, - { - "name": "API References", - "url": "api-playground" - } -] -``` + ```json + "tabs": [ + { + "name": "Writing Content", + "url": "content" + }, + { + "name": "API References", + "url": "api-playground" + } + ] + ``` The name of the tab label. + The start of the URL that marks what pages go in the tab. Generally, this is the name of the folder you put your pages in. + Pass `true` if you want to hide the tab until you directly link someone to docs inside it. @@ -409,49 +431,54 @@ Example: -An object to configure the footer with socials and links. -Example: -```json -"footer": { - "socials": { "x": "https://x.com/mintlify", "website": "https://mintlify.com" }, - "links": [ - { - "title": "Column 1", - "links": [ - { "label": "Column 1 Link 1", "url": "https://mintlify.com" }, - { "label": "Column 1 Link 2", "url": "https://mintlify.com" } - ] - }, - { - "title": "Column 2", - "links": [ - { "label": "Column 2 Link 1", "url": "https://mintlify.com" }, - { "label": "Column 2 Link 2", "url": "https://mintlify.com" } - ] - } - ] -} -``` - - - One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`, `medium`, `telegram`, `twitter` - - Example: `x` - - - The URL to the social platform. - - Example: `https://x.com/mintlify` - - - - - Title of the column - - - The link items in the column. External urls that starts with `https://` or `http://` will be opened in new tab. - - + An object to configure the footer with socials and links. + Example: + + ```json + "footer": { + "socials": { "x": "https://x.com/mintlify", "website": "https://mintlify.com" }, + "links": [ + { + "title": "Column 1", + "links": [ + { "label": "Column 1 Link 1", "url": "https://mintlify.com" }, + { "label": "Column 1 Link 2", "url": "https://mintlify.com" } + ] + }, + { + "title": "Column 2", + "links": [ + { "label": "Column 2 Link 1", "url": "https://mintlify.com" }, + { "label": "Column 2 Link 2", "url": "https://mintlify.com" } + ] + } + ] + } + ``` + + + + One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`, `medium`, `telegram`, `twitter` + + Example: `x` + + + + The URL to the social platform. + + Example: `https://x.com/mintlify` + + + + + + Title of the column + + + + The link items in the column. External urls that starts with `https://` or `http://` will be opened in new tab. + + @@ -459,13 +486,15 @@ Example: - Enables a rating system for users to indicate whether the page has been helpful + Enables a rating system for users to indicate whether the page has been helpful + - Enables a button to allow users to suggest edits via pull requests + Enables a button to allow users to suggest edits via pull requests + - Enables a button to allow users to raise an issue about the documentation + Enables a button to allow users to raise an issue about the documentation @@ -475,7 +504,7 @@ Example: - Set the prompt for the search bar. Default is `Search...` + Set the prompt for the search bar. Default is `Search...` @@ -484,6 +513,7 @@ Example: Configuration for API settings. Learn more about API pages at [API Components](/api-playground). + The base url for all API endpoints. If `baseUrl` is an array, it will enable for multiple base url @@ -492,18 +522,20 @@ Example: - + The authentication strategy used for all API endpoints. + - The name of the authentication parameter used in the API playground. + The name of the authentication parameter used in the API playground. - If method is `basic`, the format should be `[usernameName]:[passwordName]` + If method is `basic`, the format should be `[usernameName]:[passwordName]` + - The default value that's designed to be a prefix for the authentication input field. + The default value that's designed to be a prefix for the authentication input field. - E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`. + E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`. @@ -512,11 +544,12 @@ Example: Configurations for the API playground - + Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `simple` Learn more at the [playground guides](/api-playground) + By default, API playground requests are proxied by Mintlify. This setting can be used to disable this behavior. @@ -527,9 +560,11 @@ Example: Configurations for API requests + Configurations for the auto-generated API request examples + An array of strings that determine the order of the languages of the auto-generated request examples. You can either define custom languages utilizing [x-codeSamples](/api-playground/openapi/advanced-features#x-codesamples) or use our default languages which include `bash`, `python`, `javascript`, `php`, `go`, `java` @@ -543,7 +578,7 @@ Example: Configurations for the param fields in the API Playground - + The default expanded state of expandable options in the API playground. `"all"` - every expandable component is expanded @@ -556,27 +591,28 @@ Example: - A string or an array of strings of URL(s) or relative path(s) pointing to your OpenAPI file. - + Examples: + -```json Absolute -"openapi": "https://example.com/openapi.json" -``` -```json Relative -"openapi": "/openapi.json" -``` -```json Multiple -"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"] -``` - + ```json Absolute + "openapi": "https://example.com/openapi.json" + ``` + + ```json Relative + "openapi": "/openapi.json" + ``` + ```json Multiple + "openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"] + ``` + ### Integrations @@ -586,10 +622,11 @@ Example: - Enables Intercom widget on docs site. The value should be your Intercom App ID. + Enables Intercom widget on docs site. The value should be your Intercom App ID. + - Enables Frontchat widget on docs site. The value should be your Frontchat App ID. + Enables Frontchat widget on docs site. The value should be your Frontchat App ID. @@ -604,31 +641,29 @@ Example: An array of paths you want to configure to permanently redirect to another path -Example: + Example: -```json -"redirects": [ - { - "source": "/source/path", - "destination": "/destination/path" - } -] -``` + ```json + "redirects": [ + { + "source": "/source/path", + "destination": "/destination/path" + } + ] + ``` - The path that you want to redirect from. - - Example: `/source` + The path that you want to redirect from. + Example: `/source` - - The path that you want to redirect to. - Example: `/destination` + + The path that you want to redirect to. + Example: `/destination` - @@ -637,19 +672,18 @@ Example: Settings for Search Engine Optimization. -Example: + Example: -```json -"seo": { - "indexHiddenPages": true -} -``` + ```json + "seo": { + "indexHiddenPages": true + } + ``` - Enables indexing pages not included in `navigation`. + Enables indexing pages not included in `navigation`. - @@ -658,77 +692,75 @@ Example: Click on the following dropdown to view a sample configuration file - -```json -{ - "name": "Mintlify", - "logo": { - "light": "/logo/light.svg", - "dark": "/logo/dark.svg" - }, - "favicon": "/favicon.svg", - "colors": { - "primary": "#16A34A", - "light": "#4ADE80", - "dark": "#166534" - }, - "topbarLinks": [ - { - "name": "Contact Us", - "url": "mailto:support@mintlify.com" - } - ], - "topbarCtaButton": { - "name": "Get Started", - "url": "https://1tc7vihvbit.typeform.com/to/pZJ31XZB" - }, - "anchors": [ - { - "name": "API Components", - "icon": "rectangle-terminal", - "color": "#f59f0b", - "url": "api-components" + ```json + { + "name": "Mintlify", + "logo": { + "light": "/logo/light.svg", + "dark": "/logo/dark.svg" }, - { - "name": "Community", - "icon": "comments", - "color": "#2564eb", - "url": "https://discord.gg/MPNgtSZkgK" - } - ], - "navigation": [ - { - "group": "Getting Started", - "pages": ["introduction", "quickstart"] + "favicon": "/favicon.svg", + "colors": { + "primary": "#16A34A", + "light": "#4ADE80", + "dark": "#166534" }, - { - "group": "API Components", - "pages": ["api-playground/overview", "api-playground/configuration"] + "topbarLinks": [ + { + "name": "Contact Us", + "url": "mailto:support@mintlify.com" + } + ], + "topbarCtaButton": { + "name": "Get Started", + "url": "https://1tc7vihvbit.typeform.com/to/pZJ31XZB" }, - { - "group": "Settings", - "pages": ["settings/global", "settings/page"] + "anchors": [ + { + "name": "API Components", + "icon": "rectangle-terminal", + "color": "#f59f0b", + "url": "api-components" + }, + { + "name": "Community", + "icon": "comments", + "color": "#2564eb", + "url": "https://discord.gg/MPNgtSZkgK" + } + ], + "navigation": [ + { + "group": "Getting Started", + "pages": ["introduction", "quickstart"] + }, + { + "group": "API Components", + "pages": ["api-playground/overview", "api-playground/configuration"] + }, + { + "group": "Settings", + "pages": ["settings/global", "settings/page"] + }, + { + "group": "Analytics", + "pages": ["analytics/posthog"] + } + ], + "footerSocials": { + "github": "https://github.com/mintlify", + "slack": "https://mintlify.com/community", + "x": "https://x.com/mintlify" }, - { - "group": "Analytics", - "pages": ["analytics/posthog"] + "integrations": { + "intercom": "APP_ID", + "frontchat": "CHAT_ID" } - ], - "footerSocials": { - "github": "https://github.com/mintlify", - "slack": "https://mintlify.com/community", - "x": "https://x.com/mintlify" - }, - "integrations": { - "intercom": "APP_ID", - "frontchat": "CHAT_ID" } -} -``` - + ``` ## More Customization Learn more about how to further customize your docs with custom CSS and JS in -[Custom Scripts](https://mintlify.com/docs/advanced/custom/). +[Custom Scripts](https://mintlify.com/docs/advanced/custom/). \ No newline at end of file From 5c2600637d3e3b2ab01b534ad1b8f0f33804869b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 16 Nov 2024 00:03:07 +0000 Subject: [PATCH 2/2] Documentation edits made through Mintlify web editor --- settings/global.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/settings/global.mdx b/settings/global.mdx index d2399e7ff..7ef092cfa 100644 --- a/settings/global.mdx +++ b/settings/global.mdx @@ -103,7 +103,7 @@ settings. Learn more about the [properties](#properties) or from an Custom fonts. Apply globally or set different fonts for headings and the body @@ -294,7 +294,7 @@ settings. Learn more about the [properties](#properties) or from an under a version, and once you specify the `locale` any fixed text in Mintlify, such as 'Was this page helpful?', will automatically be translated based on the locale. We currently support localization in English, Chinese, Spanish, French, - Japanese, Portuguese, and German. + Japanese, and Portuguese. For more information, please refer to our [versioning documentation](/settings/versioning). @@ -326,7 +326,7 @@ settings. Learn more about the [properties](#properties) or from an - The locale of the version. Supported locales are `en`, `cn`, `es`, `fr`, `jp`, `pt`, `pt-BR`. + The locale of the version. Supported locales are `en`, `cn`, `es`, `fr`, `jp`, `pt`, `pt-BR`, `de`.