Redirects

When you restructure your docs, redirects keep old links working. Define them in your docs.json:

123456{
  "redirects": [
    { "source": "/old-page", "destination": "/new-page" },
    { "source": "/guides/:slug", "destination": "/docs/:slug" }
  ]
}

Redirect types

Exact path

1{ "source": "/changelog", "destination": "/updates" }

Named parameters

Capture path segments with :param and reuse them in the destination:

1{ "source": "/api/:version/users", "destination": "/reference/:version/users" }

Trailing wildcard

Match any path under a prefix:

1{ "source": "/old-docs/*", "destination": "/docs/:splat" }

Permanent vs temporary

By default, redirects use a 302 (temporary) status code. Set permanent: true for a 301:

12345{
  "source": "/legacy",
  "destination": "/modern",
  "permanent": true
}

Query string preservation

Query parameters from the original request are passed through to the destination URL.

Ask AI about this page