3.3 KiB
title | linktitle | description | date | publishdate | lastmod | categories | keywords | menu | weight | draft | aliases | toc | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Custom 404 Page | 404 Page | If you know how to create a single page template, you have unlimited options for creating a custom 404. | 2017-02-01 | 2017-02-01 | 2017-03-31 |
|
|
|
120 | false | false |
When using Hugo with GitHub Pages, you can provide your own template for a custom 404 error page by creating a 404.html template file in your /layouts
folder. When Hugo generates your site, the 404.html
file will be placed in the root.
404 pages will have all the regular page variables available to use in the templates.
In addition to the standard page variables, the 404 page has access to all site content accessible from .Pages
.
▾ layouts/
404.html
404.html
This is a basic example of a 404.html template:
{{< code file="layouts/404.html" download="404.html" >}} {{ define "main"}}
<a href="{{ "/" | relURL }}">Go Home
Automatic Loading
Your 404.html file can be set to load automatically when a visitor enters a mistaken URL path, dependent upon the web serving environment you are using. For example:
- GitHub Pages and GitLab Pages. The 404 page is automatic.
- Apache. You can specify
ErrorDocument 404 /404.html
in an.htaccess
file in the root of your site. - Nginx. You might specify
error_page 404 /404.html;
in yournginx.conf
file. Details here. - Amazon AWS S3. When setting a bucket up for static web serving, you can specify the error file from within the S3 GUI.
- Amazon CloudFront. You can specify the page in the Error Pages section in the CloudFront Console. Details here
- Caddy Server. Use the
handle_errors
directive to specify error pages for one or more status codes. Details here - Netlify. Add
/* /404.html 404
tocontent/_redirects
. Details Here - Azure Static website. You can specify the
Error document path
in the Static website configuration page of the Azure portal. More details are available in the Static website documentation. - DigitalOcean App Platform. You can specify
error_document
in your app specification file or use control panel to set up error document. Details here.
{{% note %}}
hugo server
will not automatically load your custom 404.html
file, but you
can test the appearance of your custom "not found" page by navigating your
browser to /404.html
.
{{% /note %}}