You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/products/docs/pages/navigation/overview.mdx
+11Lines changed: 11 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,8 @@ description: Set up the navigation for your documentation site built with Fern D
5
5
6
6
Every Fern Docs website has a special configuration file called `docs.yml`. Use this file to configure the navigation for your documentation site.
7
7
8
+
test
9
+
8
10
Here's a complete example of a `docs.yml` file:
9
11
10
12
<CodeBlocktitle="An example docs.yml">
@@ -99,6 +101,7 @@ For the pages in a folder, Fern automatically converts filenames to titles and U
99
101
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.
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).
146
151
</Note>
@@ -170,6 +175,7 @@ navigation:
170
175
To add an overview page to a section, add a `path` property to the section.
171
176
172
177
{/* <!-- vale off --> */}
178
+
173
179
```yaml Example section with an overview {7}
174
180
navigation:
175
181
- section: Introduction
@@ -184,6 +190,7 @@ navigation:
184
190
- page: Complex guide
185
191
path: ./pages/guides/complex.mdx
186
192
```
193
+
187
194
{/* <!-- vale on --> */}
188
195
189
196
## Nested sections
@@ -244,6 +251,7 @@ Add icons next to sections, pages, and folders using the `icon` key.
244
251
<Markdown src="/snippets/icons.mdx" />
245
252
246
253
{/* <!-- vale off --> */}
254
+
247
255
```yaml Example config with different icon files {3, 6, 10-11, 14}
248
256
navigation:
249
257
- section: Home
@@ -259,13 +267,15 @@ navigation:
259
267
- api: API Reference
260
268
icon: fa-regular fa-puzzle
261
269
```
270
+
262
271
{/* <!-- vale on --> */}
263
272
264
273
## Links
265
274
266
275
You can add a link to an external page within your sidebar navigation with the following configuration:
0 commit comments