Changelog

Stable named preview links

Share a single preview link with reviewers that stays up to date as you push changes by passing an --id to fern generate --docs --preview. Rerunning with the same --id updates the existing preview in place rather than creating a new URL.

$
fern generate --docs --preview --id my-feature

To set this up in CI, update your GitHub Actions workflow to pass the branch name as the --id.

Multi-file ZIP downloads

The <Download> component now supports bundling multiple files into a single ZIP download using the new sources prop. This is useful when you want users to download a collection of related assets — such as brand logos, SDK files, or configuration templates — without needing to host a pre-built ZIP file.

Pass an array of publicly accessible URLs to sources, and the component fetches each file client-side and packages them into a ZIP archive:

1
<Download
2
  sources={[
3
    "https://example.com/assets/logo-dark.svg",
4
    "https://example.com/assets/logo-light.svg",
5
    "https://example.com/assets/icon.svg"
6
  ]}
7
  filename="brand-assets.zip"
8
>
9
  <Button intent="primary">Download brand assets</Button>
10
</Download>

open-by-default option for collapsed sections

Sections and folders in your sidebar navigation support a new collapsed: open-by-default value. Sections configured with this value start expanded but display a toggle so users can collapse them.

1
navigation:
2
  - section: API guides
3
    collapsed: open-by-default
4
    contents:
5
      - page: Authentication
6
        path: ./pages/api/auth.mdx
7
      - page: Pagination
8
        path: ./pages/api/pagination.mdx

Dynamic OG images Beta

Fern can now automatically generate unique Open Graph images for each page of your docs site. Set og:dynamic to true in your docs.yml metadata to enable it. Pages with an og:image set in frontmatter will use the specified image instead.

You can also use og:background-image to set a custom background image for your dynamically generated OG image, instead of a solid color.

1
metadata:
2
  og:dynamic: true
3
  og:background-image: ./images/og-background.png # optional

Preview workflow with direct page links

You can now use an updated GitHub Actions preview workflow that comments on your pull request with direct links to every page you changed, so reviewers can jump straight to affected pages without navigating through the full site. The comment updates with a new preview link and refreshed page links when you push new commits.

To adopt this workflow, replace your .github/workflows/preview-docs.yml with the updated version. New sites created through the guided UI or CLI quickstart include it automatically.

OAuth logout endpoint

You can now configure a logout URL for OAuth authentication. When a user clicks Logout, Fern redirects them to your OAuth provider’s logout endpoint to end their session, in addition to clearing the local session cookie. To set this up, send your logout URL (e.g., https://<your-oauth-tenant>/oauth2/logout) to Fern alongside your other OAuth client details.

“Edit this page” with Fern Editor

The “Edit this page” button can now open Fern Editor in addition to linking to GitHub. When you set the launch mode to dashboard, clicking the button gives users the choice between editing the page in Fern Editor or viewing the source on GitHub. This is especially useful for internal docs sites where most viewers are also editors.

Collaborative editor sessions

You can now view and edit your teammates’ Fern Editor sessions. If a teammate creates an editor session, you can open their session from the Dashboard and commit changes directly to their PR. This makes it easy to adjust copy or fix content without switching to GitHub.

Learn more about the Fern Editor.

Pull request attribution in Fern Writer

Fern Writer now includes a Requested by field in every pull request description, attributing each documentation change to the person or team that initiated the request. Commits are signed and attributed to fern-support, making automated changes clearly distinguishable from manual contributions in your repository’s history.

OpenAPI spec endpoints

Your Fern docs site now serves your raw OpenAPI 3.1 specification at /openapi.json and /openapi.yaml. Download it for SDK generation, contract testing, or importing into tools like Postman. The spec is also linked from your site’s llms.txt, so AI coding assistants can discover and use it automatically.

Edit site logo, favicon, and title from the editor

You can now update your site’s logo, favicon, and title directly from Fern Editor — no need to edit configuration files manually. Navigate to site settings in the editor to make changes visually.

Link to API endpoints with api: syntax

Link to API endpoints by HTTP method and path using the api: link syntax, instead of hardcoding URL slugs. Fern resolves these links to the correct endpoint URL at build time.

1
[Create a payment](api:POST/v2/payments)

This works in Markdown pages, OpenAPI description fields, and Fern Definition docs fields.