Creating a custom 404 page for your GitHub Pages site
You can display a custom 404 error page when people try to access nonexistent pages on your site.
GitHub Pages is available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server.
-
On GitHub Enterprise, navigate to your site's repository.
-
Navigate to the publishing source for your site. For more information about publishing sources, see "About GitHub Pages."
-
Above the file list, click Create new file.
-
In the file name field, type
404.html
or404.md
. -
If you named your file
404.md
, add the following YAML front matter to the beginning of the file:--- permalink: /404.html ---
-
Below the YAML front matter, if present, add the content you want to display on your 404 page.
-
At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."
-
Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is
master
, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request." -
Click Propose new file.
Further reading
- Front matter in the Jekyll documentation