Skip to content

docs: add documentation for theme.footerNav configuration #1936

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

Closed
wants to merge 1 commit into from
+36 −0
Closed

docs: add documentation for theme.footerNav configuration #1936

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
17 changes: 17 additions & 0 deletions fern/products/docs/pages/changelog/2025-11-11.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,20 @@ Then, the API Explorer automatically displays all available authentication optio
</Frame>

Learn more about configuring authentication in the [API Explorer documentation](/learn/docs/api-references/api-explorer/overview).

## New footer navigation style option

You can now customize the appearance of your documentation's footer navigation using the `theme.footerNav` configuration in `docs.yml`. This setting controls how the previous and next page buttons appear at the bottom of each documentation page.

The new `minimal` style provides a cleaner, more symmetrical layout where both previous and next buttons display page titles with subtle hover effects. The `default` style preserves the original design where only the next button shows the page title.

```yaml docs.yml
theme:
footerNav: minimal # or "default"
```

**Available options:**
- `default`: Previous button shows only a chevron and "Previous" text. Next button displays as a card with the page title and optional excerpt.
- `minimal`: Both previous and next buttons show page titles with a clean, minimal design and hover animations.

Learn more in the [site-level settings documentation](/learn/docs/configuration/site-level-settings#theme-configuration).
19 changes: 19 additions & 0 deletions fern/products/docs/pages/customization/site-level-settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,6 +573,25 @@ layout:
If set to true, the feedback form won't be rendered. This can be overridden on a per-page basis using the [frontmatter](/learn/docs/configuration/page-level-settings#on-page-feedback).
</ParamField>

## Theme configuration

Configure the visual style and behavior of UI elements in your documentation site.

```yaml docs.yml
theme:
footerNav: minimal
```

<ParamField path="theme.footerNav" type="enum" required={false} default="default" toc={true}>
Controls the style of the footer navigation buttons that appear at the bottom of each page for moving between pages.

**Options:**
- `default`: Previous button shows only a chevron and "Previous" text (no page title). Next button displays as a card with the page title, optional excerpt, background, and border.
- `minimal`: Both previous and next buttons show page titles with a clean, minimal design. Includes subtle hover effects with chevron animations and no background or border styling.

The default style preserves the original footer navigation design. Use the minimal style for a cleaner, more symmetrical footer navigation layout.
</ParamField>

## Settings configuration

```yaml docs.yml
Expand Down