diff --git a/fern/products/docs/pages/customization/what-is-docs-yml.mdx b/fern/products/docs/pages/customization/what-is-docs-yml.mdx index 442f8d74d..f569be63a 100644 --- a/fern/products/docs/pages/customization/what-is-docs-yml.mdx +++ b/fern/products/docs/pages/customization/what-is-docs-yml.mdx @@ -89,6 +89,11 @@ navbar-links: [`layout` configuration](/learn/docs/getting-started/global-configuration#layout-configuration). + + Customize the settings of your documentation website. Learn more about the + [`settings` configuration](/learn/docs/getting-started/global-configuration#settings-configuration). + + Creates a landing page for your documentation website. Learn more about the [`landing-page` configuration](/learn/docs/getting-started/global-configuration#landing-page-configuration). @@ -446,6 +451,51 @@ layout: If set to true, the feedback form will not be rendered. This can be overridden on a per-page basis using the [frontmatter](/learn/docs/configuration/page-level-settings#on-page-feedback). +## Settings configuration + +```yaml docs.yml +settings: + search-text: "Search the docs..." + disable-search: false + dark-mode-code: true + default-search-filters: true + http-snippets: true + hide-404-page: true + use-javascript-as-typescript: false +``` + + + The text to display in the searchbar. + + + + If set to true, the searchbar will be disabled. Use this if you want to use a custom search solution. + + + + If set to true, the code blocks will be displayed in dark mode, regardless of the selected theme. + + + + By default, search will display results for pages across all products and versions. + + If set to true, search will display results for pages within the current product and version. + + + + If set to true, the HTTP snippets will be displayed in the API Reference. + + + + If set to true, when a user navigates to a page that does not exist, they will be redirected to the home page. + + By default, a 404 page will be displayed. + + + + If set to true, the TypeScript snippets will be displayed as JavaScript snippets in the API Reference. + + ## GitHub configuration diff --git a/fern/snippets/seo-metadata-site.mdx b/fern/snippets/seo-metadata-site.mdx index fa728de3b..b0d5c4d8e 100644 --- a/fern/snippets/seo-metadata-site.mdx +++ b/fern/snippets/seo-metadata-site.mdx @@ -82,3 +82,9 @@ metadata: The Twitter Card type. Options are `summary`, `summary_large_image`, `app`, or `player`. + + + The host of your documentation website. This will be used to set the canonical URL for metadata tags and documents like the sitemap. + + Defaults to the URL defined in the `instances` configuration. +