Configure links and redirects for your site

Redirects

The redirects object allows you to redirect traffic from one path to another. You can also use regex within redirects.

Redirect exact paths

Redirect with regex

docs.yml

1 redirects:
2   - source: "/old-path"
3     destination: "/new-path"
4   - source: "/incorrect/path"
5     destination: "/correct/path"

By default, the redirects implement temporary (302) redirects. If you would like to implement permanent (301) redirects, you can set permanent: true.

docs.yml

1 redirects:
2   - source: "/old-subdomain"
3     destination: "/new-subdomain"
4     permanent: true

Subpaths

If your docs are hosted on a subpath (like buildwithfern.com/learn), be sure to include the subpath in the redirect.

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/