Configure links and redirects for your site

Redirects

The redirects object allows you to redirect traffic from one path to another. You can redirect exact paths or use dynamic patterns with regex parameters like :slug.

If your docs are hosted on a subpath (like buildwithfern.com/learn), include the subpath in both the source and destination paths.

docs.yml

1 redirects:
2   # Exact path redirects
3   - source: "/old-path"
4     destination: "/new-path"
5   - source: "/old-folder/path"
6     destination: "/new-folder/path"
7     permanent: true
8     
9   # Regex-based redirects  
10   - source: "/old-folder/:slug" # <- /old-folder/foo, /old-folder/bar, etc.
11     destination: "/new-folder/:slug"
12   - source: "/old-folder/:slug*" # <- /incorrect, /incorrect/foo/bar/baz, etc.
13     destination: "/new-folder/:slug*"

Parameters suffixed with an asterisk (*) match zero or more path segments, capturing everything that follows in the URL. Use this when redirecting entire folder structures while preserving nested paths.

source

stringRequired

The path that you want to redirect from.

destination

stringRequired

The path that you want to redirect to.

permanent

boolean

Toggle between permanent and temporary redirect (default false). When true, the status code is 308. When false, the status code is 307.

Links

You can add a link to an external page within your sidebar navigation with the following configuration:

docs.yml

1 navigation: 
2   - section: Home
3     contents:
4       - page: Introduction
5         path: ./intro.mdx
6       - link: Our YouTube Channel
7         href: https://www.youtube.com/