Skip to content

chore: document global config options #764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2025
Merged

chore: document global config options #764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern/products/docs/pages/customization/frontmatter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,8 @@ max-toc-depth: 3
## Navigation links
<ParamField path="hide-nav-links" type="boolean" required={false} default={false}>
Controls the conditional rendering of the navigation links (previous, next) at the bottom of the page. Set to true to disable this feature.

This can be set globally in the [global configuration](/learn/docs/configuration/what-is-docs-yml#layout-configuration).
</ParamField>

<CodeBlock title="Example hide-nav-links">
Expand All @@ -194,6 +196,8 @@ hide-nav-links: true
## On-page feedback
<ParamField path="hide-feedback" type="boolean" required={false} default={false}>
Controls the conditional rendering of the on-page feedback form at the bottom of the page. Set to true to disable this feature.

This can be set globally in the [global configuration](/learn/docs/configuration/what-is-docs-yml#layout-configuration).
</ParamField>

<CodeBlock title="Example hide-feedback">
Expand Down
10 changes: 10 additions & 0 deletions fern/products/docs/pages/customization/global-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,8 @@ layout:
searchbar-placement: header
tabs-placement: header
content-alignment: left
hide-nav-links: true
hide-feedback: true
```

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

<ParamField path="layout.hide-nav-links" type="boolean" required={false}>
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).
</ParamField>

<ParamField path="layout.hide-feedback" type="boolean" required={false}>
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).
</ParamField>

## GitHub configuration

<Tabs>
Expand Down