Custom 404 page

Customize the title, description, and appearance of your documentation site’s 404 error page to match your brand and guide visitors.

All 404 pages automatically suggest relevant pages based on the requested URL. If users land on a 404 page, an agent analyzes the path and retrieves semantically related pages from your documentation to help them find what they’re looking for.

You can customize the title and description of the 404 error page. Use the description to add helpful links or guidance.

Configuration

Configure your 404 page in the errors.404 section of your docs.json file:

"errors": {
  "404": {
    "redirect": false,
    "title": "I can't be found",
    "description": "What ever **happened** to this _page_?"
  }
}

Parameters

redirect · boolean

Whether to automatically redirect to the home page when a page is not found.

Set to true to redirect to the home page.

Set to false to show the custom 404 page.

title · string

Custom title for the 404 error page. This replaces the default “Page not found” heading.

description · string

Custom description for the 404 error page. Supports MDX formatting including links, bold, italic text, and custom components.