Skip to content

Commit 040f7af

Browse files
Fern Editor: Update
1 parent 24d8c51 commit 040f7af

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

fern/products/docs/pages/navigation/overview.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: Set up the navigation for your documentation site built with Fern D
55

66
Every Fern Docs website has a special configuration file called `docs.yml`. Use this file to configure the navigation for your documentation site.
77

8+
test
9+
810
Here's a complete example of a `docs.yml` file:
911

1012
<CodeBlock title="An example docs.yml">
@@ -99,6 +101,7 @@ For the pages in a folder, Fern automatically converts filenames to titles and U
99101
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.
100102

101103
{/* <!-- vale off --> */}
104+
102105
```yaml docs.yml {7, 10, 12}
103106
navigation:
104107
- section: Introduction
@@ -117,6 +120,7 @@ navigation:
117120
- page: Another hidden page
118121
path: ./pages/also-hidden.mdx
119122
```
123+
120124
{/* <!-- vale on --> */}
121125

122126
## Availability
@@ -141,6 +145,7 @@ navigation:
141145
title: Performance monitoring
142146
availability: in-development # Overrides section-level availability
143147
```
148+
144149
<Note>
145150
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).
146151
</Note>
@@ -170,6 +175,7 @@ navigation:
170175
To add an overview page to a section, add a `path` property to the section.
171176

172177
{/* <!-- vale off --> */}
178+
173179
```yaml Example section with an overview {7}
174180
navigation:
175181
- section: Introduction
@@ -184,6 +190,7 @@ navigation:
184190
- page: Complex guide
185191
path: ./pages/guides/complex.mdx
186192
```
193+
187194
{/* <!-- vale on --> */}
188195

189196
## Nested sections
@@ -244,6 +251,7 @@ Add icons next to sections, pages, and folders using the `icon` key.
244251
<Markdown src="/snippets/icons.mdx" />
245252

246253
{/* <!-- vale off --> */}
254+
247255
```yaml Example config with different icon files {3, 6, 10-11, 14}
248256
navigation:
249257
- section: Home
@@ -259,13 +267,15 @@ navigation:
259267
- api: API Reference
260268
icon: fa-regular fa-puzzle
261269
```
270+
262271
{/* <!-- vale on --> */}
263272

264273
## Links
265274

266275
You can add a link to an external page within your sidebar navigation with the following configuration:
267276

268277
{/* <!-- vale off --> */}
278+
269279
```yaml title="docs.yml"
270280
navigation:
271281
- section: Home
@@ -275,6 +285,7 @@ navigation:
275285
- link: Our YouTube channel
276286
href: https://www.youtube.com/
277287
```
288+
278289
{/* <!-- vale on --> */}
279290

280291
<Frame>

0 commit comments

Comments
 (0)