Custom 404 page

Customize the title and description of your 404 error page

You can control the title and description of the 404 error page that appears when users navigate to broken or missing links.

When customizing your 404 page, use the description to guide users to helpful resources or links in your documentation that can help them find what they’re looking for.

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 Markdown formatting.