Skip to content

Document layout.breadcrumbs.sticky docs.yml setting #7874

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

Open
devin-ai-integration wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document layout.breadcrumbs.sticky docs.yml setting #7874

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
528b487
Document layout.breadcrumbs.sticky in docs.yml
devin-ai-integration[bot] Nov 14, 2026
bc98f1f
Reword sticky breadcrumbs description
devin-ai-integration[bot] Nov 14, 2026
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
12 changes: 6 additions & 6 deletions fern/products/docs/pages/navigation/site-level-settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -610,12 +610,12 @@ layout:
hide-nav-links: true
breadcrumbs:
current-page: true
sticky: true
hide-feedback: true
changelog-layout: timeline
api-reference-layout: indented
show-nav-availability-badges: true
hide-webhook-method-badges: true
breadcrumbs.current-page: true
```

<ParamField path="layout.header-height" type="string" required={false} toc={true}>
Expand Down Expand Up @@ -669,7 +669,11 @@ layout:
</ParamField>

<ParamField path="layout.breadcrumbs.current-page" type="boolean" required={false} default="false" toc={true}>
When `true`, appends the current page title as a non-clickable final breadcrumb above the page title. Defaults to `false`.
If set to true, the current page's title is appended to the breadcrumb trail above the page title as a non-clickable item (rendered as a `<span>` with `aria-current="page"`). Ancestor breadcrumb items remain clickable links.
</ParamField>

<ParamField path="layout.breadcrumbs.sticky" type="boolean" required={false} default="false" toc={true}>
If set to true, the breadcrumb row above the page title stays pinned below the header while the page scrolls. This applies to guide pages and API endpoint pages. On mobile, when [`layout.mobile-toc`](#layoutmobile-toc) is enabled, the pinned breadcrumbs sit above the mobile table of contents bar. Combine with `layout.breadcrumbs.current-page` to keep the current page's title in the pinned row.
</ParamField>

<ParamField path="layout.hide-feedback" type="boolean" required={false} default="false" toc={true}>
Expand Down Expand Up @@ -712,10 +716,6 @@ layout:
If set to true, [webhook](/learn/docs/api-references/generate-webhook-ref) entries in the sidebar are rendered without an HTTP method badge (e.g., `POST`). Endpoint entries keep their method badges, and webhook pages are unchanged.
</ParamField>

<ParamField path="layout.breadcrumbs.current-page" type="boolean" required={false} default="false" toc={true}>
When set to `true`, the current page's title is appended to the page-header breadcrumb trail as a non-clickable item (rendered as a `<span>` with `aria-current="page"`). Ancestor breadcrumb items remain clickable links. Defaults to `false` — no change for existing sites.
</ParamField>

## Theme configuration

Customize the visual style of specific UI elements across your documentation site.
Expand Down
Loading