Skip to content

Commit 6e5cc28

Browse files
authored
chore: document global config options (#764)
1 parent e143aa8 commit 6e5cc28

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

fern/products/docs/pages/customization/frontmatter.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,8 @@ max-toc-depth: 3
176176
## Navigation links
177177
<ParamField path="hide-nav-links" type="boolean" required={false} default={false}>
178178
Controls the conditional rendering of the navigation links (previous, next) at the bottom of the page. Set to true to disable this feature.
179+
180+
This can be set globally in the [global configuration](/learn/docs/configuration/what-is-docs-yml#layout-configuration).
179181
</ParamField>
180182

181183
<CodeBlock title="Example hide-nav-links">
@@ -194,6 +196,8 @@ hide-nav-links: true
194196
## On-page feedback
195197
<ParamField path="hide-feedback" type="boolean" required={false} default={false}>
196198
Controls the conditional rendering of the on-page feedback form at the bottom of the page. Set to true to disable this feature.
199+
200+
This can be set globally in the [global configuration](/learn/docs/configuration/what-is-docs-yml#layout-configuration).
197201
</ParamField>
198202

199203
<CodeBlock title="Example hide-feedback">

fern/products/docs/pages/customization/global-configuration.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,8 @@ layout:
402402
searchbar-placement: header
403403
tabs-placement: header
404404
content-alignment: left
405+
hide-nav-links: true
406+
hide-feedback: true
405407
```
406408

407409
<ParamField path="layout.header-height" type="string" required={false}>
@@ -446,6 +448,14 @@ layout:
446448
and a 1px border will separate the sidebar from the content.
447449
</ParamField>
448450

451+
<ParamField path="layout.hide-nav-links" type="boolean" required={false}>
452+
If set to true, the navigation links (previous, next) at the bottom of the page will not be rendered. This can be overridden on a per-page basis using the [frontmatter](/learn/docs/configuration/page-level-settings#navigation-links).
453+
</ParamField>
454+
455+
<ParamField path="layout.hide-feedback" type="boolean" required={false}>
456+
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).
457+
</ParamField>
458+
449459
## GitHub configuration
450460

451461
<Tabs>

0 commit comments

Comments
 (0)