diff --git a/docs.json b/docs.json index 719f897ea..933526451 100644 --- a/docs.json +++ b/docs.json @@ -144,6 +144,7 @@ "guides/changelogs", "guides/hidden-pages", "settings/broken-links", + "settings/custom-404-page", "guides/monorepo", { "group": "Custom Subdirectory", diff --git a/settings/custom-404-page.mdx b/settings/custom-404-page.mdx new file mode 100644 index 000000000..916028a51 --- /dev/null +++ b/settings/custom-404-page.mdx @@ -0,0 +1,41 @@ +--- +title: "Custom 404 page" +description: "Customize the title and description of your 404 error page" +icon: "file-warning" +--- + +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: + +```json +"errors": { + "404": { + "redirect": false, + "title": "I can't be found", + "description": "What ever **happened** to this _page_?" + } +} +``` + +## Parameters + + + 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. + + + + Custom title for the 404 error page. This replaces the default "Page not found" heading. + + + + Custom description for the 404 error page. Supports Markdown formatting. +