diff --git a/fern/products/docs/pages/navigation/overview.mdx b/fern/products/docs/pages/navigation/overview.mdx index 20c3b38a..d4c110ef 100644 --- a/fern/products/docs/pages/navigation/overview.mdx +++ b/fern/products/docs/pages/navigation/overview.mdx @@ -5,6 +5,8 @@ description: Set up the navigation for your documentation site built with Fern D Every Fern Docs website has a special configuration file called `docs.yml`. Use this file to configure the navigation for your documentation site. +test + Here's a complete example of a `docs.yml` file: @@ -99,6 +101,7 @@ For the pages in a folder, Fern automatically converts filenames to titles and U To hide a page, folder, or section, add `hidden: true`. Hidden content (including all pages within a folder) is still accessible via direct URL but is excluded from search and won't be indexed. {/* */} + ```yaml docs.yml {7, 10, 12} navigation: - section: Introduction @@ -117,6 +120,7 @@ navigation: - page: Another hidden page path: ./pages/also-hidden.mdx ``` + {/* */} ## Availability @@ -141,6 +145,7 @@ navigation: title: Performance monitoring availability: in-development # Overrides section-level availability ``` + If you have different versions of your docs, section, folder, and page availability should be set in [the `.yml` files that define the navigational structure for each version](/learn/docs/configuration/versions#define-your-versions). @@ -170,6 +175,7 @@ navigation: To add an overview page to a section, add a `path` property to the section. {/* */} + ```yaml Example section with an overview {7} navigation: - section: Introduction @@ -184,6 +190,7 @@ navigation: - page: Complex guide path: ./pages/guides/complex.mdx ``` + {/* */} ## Nested sections @@ -244,6 +251,7 @@ Add icons next to sections, pages, and folders using the `icon` key. {/* */} + ```yaml Example config with different icon files {3, 6, 10-11, 14} navigation: - section: Home @@ -259,6 +267,7 @@ navigation: - api: API Reference icon: fa-regular fa-puzzle ``` + {/* */} ## Links @@ -266,6 +275,7 @@ navigation: You can add a link to an external page within your sidebar navigation with the following configuration: {/* */} + ```yaml title="docs.yml" navigation: - section: Home @@ -275,6 +285,7 @@ navigation: - link: Our YouTube channel href: https://www.youtube.com/ ``` + {/* */}