You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "Customize the title and description of your 404 error page"
4
+
icon: "file-warning"
5
+
---
6
+
7
+
You can control the title and description of the 404 error page that appears when users navigate to broken or missing links.
8
+
9
+
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.
10
+
11
+
## Configuration
12
+
13
+
Configure your 404 page in the `errors.404` section of your `docs.json` file:
14
+
15
+
```json
16
+
"errors": {
17
+
"404": {
18
+
"redirect": false,
19
+
"title": "I can't be found",
20
+
"description": "What ever **happened** to this _page_?"
21
+
}
22
+
}
23
+
```
24
+
25
+
## Parameters
26
+
27
+
<ResponseFieldname="redirect"type="boolean">
28
+
Whether to automatically redirect to the home page when a page is not found.
29
+
30
+
Set to `true` to redirect to the home page.
31
+
32
+
Set to `false` to show the custom 404 page.
33
+
</ResponseField>
34
+
35
+
<ResponseFieldname="title"type="string">
36
+
Custom title for the 404 error page. This replaces the default "Page not found" heading.
37
+
</ResponseField>
38
+
39
+
<ResponseFieldname="description"type="string">
40
+
Custom description for the 404 error page. Supports Markdown formatting.
0 commit comments