diff --git a/api-playground/openapi-setup.mdx b/api-playground/openapi-setup.mdx index fadf690815..c7bb48a346 100644 --- a/api-playground/openapi-setup.mdx +++ b/api-playground/openapi-setup.mdx @@ -343,7 +343,7 @@ In this example, the navigation group displays as "User Management" but the gene Add an `openapi` field to any navigation element in your `docs.json` to automatically generate pages for OpenAPI endpoints. You can control where these pages appear in your navigation structure, as dedicated API sections or with other pages. -The `openapi` field accepts either a path in your docs repo or a URL to a hosted OpenAPI document. +The `openapi` field accepts either a path in your docs repo or a URL to a hosted OpenAPI document. Hosted specs must be reachable from the public internet; `localhost` URLs and private hosts cannot be fetched at build time. When you use a URL for your OpenAPI spec, changes to the spec don't trigger a Git push, so your docs won't redeploy automatically. To keep your docs in sync, call the [Trigger deployment](/api/update/trigger) API endpoint in the same CI action that generates or updates your spec. This way your docs update automatically without needing to manually trigger a deployment from the dashboard. diff --git a/customize/custom-scripts.mdx b/customize/custom-scripts.mdx index 2bede3b03f..bcd0a16553 100644 --- a/customize/custom-scripts.mdx +++ b/customize/custom-scripts.mdx @@ -343,6 +343,49 @@ Multiple instances of these elements can appear on a page. Use these as `value` +### Common customizations + +Mintlify's appearance settings in `docs.json` do not include options for sidebar width, font size, or other fine-grained layout controls. To adjust these, target the selectors above with custom CSS. + + + + Override the sidebar container width to make the sidebar narrower or wider. The main content area adjusts automatically. + + ```css + #sidebar { + width: 240px; + } + ``` + + + The `fonts` field in `docs.json` sets font family and weight, but not font size. Use custom CSS to resize sidebar text. + + ```css + #sidebar-content { + font-size: 0.8rem; + } + ``` + + + Resize the main content area without changing headings. + + ```css + #content-area { + font-size: 0.95rem; + } + ``` + + + Prefer removing `navbar.primary` from `docs.json` when possible. If you need to hide the button conditionally with CSS, target its ID: + + ```css + #topbar-cta-button { + display: none; + } + ``` + + + ## Custom JavaScript Custom JS lets you add custom executable code globally. It is the equivalent of adding a `