404 and error pages in Astro

Introduction

404 and error pages help visitors know when something went wrong or a page is missing. They make your website friendlier and easier to use.

When a visitor tries to open a page that does not exist on your site.

When your website encounters a server error and cannot show the requested page.

To guide users back to working parts of your site after an error.

To show a custom message instead of a confusing default error.

To keep your website looking good even when problems happen.

Syntax

Astro

---
export const prerender = true;
---
<html lang="en">
  <head>
    <title>Page Not Found</title>
  </head>
  <body>
    <h1>404 - Page Not Found</h1>
    <p>Sorry, we couldn't find the page you were looking for.</p>
    <a href="/">Go back home</a>
  </body>
</html>

Astro uses special files like 404.astro to show custom 404 pages.

Setting export const prerender = true; helps Astro generate the page at build time.

Examples

A simple 404 page with a friendly message and a link back to the homepage.

Astro

---
export const prerender = true;
---
<html lang="en">
  <head><title>404 Not Found</title></head>
  <body>
    <h1>Oops! Page not found.</h1>
    <p>Try checking the URL or go back home.</p>
    <a href="/">Home</a>
  </body>
</html>

A basic error page to show when the site has a problem other than 404.

Astro

---
export const prerender = true;
---
<html lang="en">
  <head><title>Error</title></head>
  <body>
    <h1>Something went wrong.</h1>
    <p>Please try again later or contact support.</p>
    <a href="/">Home</a>
  </body>
</html>

Sample Program

This is a complete 404 page in Astro. It shows a clear message, uses simple styling, and includes a link with an accessible label to help users return home.

Astro

---
export const prerender = true;
---
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>404 - Not Found</title>
    <style>
      body {
        font-family: system-ui, sans-serif;
        text-align: center;
        padding: 4rem;
        background-color: #f9f9f9;
        color: #333;
      }
      a {
        color: #007acc;
        text-decoration: none;
        font-weight: bold;
      }
      a:hover {
        text-decoration: underline;
      }
    </style>
  </head>
  <body>
    <h1>404</h1>
    <p>Sorry, the page you are looking for does not exist.</p>
    <a href="/" aria-label="Go back to homepage">Go back home</a>
  </body>
</html>

Important Notes

Always create a 404.astro file in your src/pages folder to handle missing pages.

Use clear, friendly language to help visitors understand what happened.

Include links to help users navigate back to working parts of your site.

Summary

404 and error pages improve user experience by explaining problems clearly.

Astro uses special files like 404.astro to show these pages automatically.

Keep messages simple, friendly, and provide navigation options.

Practice

1. What is the main purpose of a 404.astro page in an Astro project?

easy

A. To speed up the loading of the homepage

B. To display the site map automatically

C. To handle user login and authentication

D. To show a friendly message when a user visits a page that does not exist

Solution

1. Step 1: Understand the role of 404 pages

   A 404 page appears when a user tries to visit a page that the website cannot find.

2. Step 2: Identify the purpose in Astro

   In Astro, 404.astro is used to show a friendly message for missing pages.

3. Final Answer:

   To show a friendly message when a user visits a page that does not exist -> Option D

4. Quick Check:

   404 page = friendly missing page message [OK]

Hint: 404 pages show missing page messages [OK]

Common Mistakes:

• Thinking 404 pages speed up the homepage
• Confusing 404 pages with login pages
• Assuming 404 pages show site maps

2. Which file name should you create in an Astro project to automatically handle 404 errors?

easy

A. error.astro

B. notfound.astro

C. 404.astro

D. page404.astro

Solution

1. Step 1: Recall Astro's naming convention for 404 pages

   Astro uses the exact file name 404.astro to detect and serve 404 error pages automatically.

2. Step 2: Compare options with the required file name

   Only 404.astro matches the required name; others won't be recognized automatically.

3. Final Answer:

   404.astro -> Option C

4. Quick Check:

   404 page file = 404.astro [OK]

Hint: Use exact file name 404.astro for error pages [OK]

Common Mistakes:

• Using names like error.astro or notfound.astro
• Adding prefixes or suffixes to 404 file name
• Assuming any file with '404' works

3. Given this 404.astro code snippet, what will the user see when visiting a missing page?

<!-- 404.astro -->
<h1>Oops! Page not found.</h1>
<p>Try going back to the <a href='/'>homepage</a>.</p>

medium

A. A blank page with no message

B. A message saying 'Oops! Page not found.' with a link to homepage

C. An error message with code 500

D. The homepage content without any error message

Solution

1. Step 1: Read the 404.astro content

   The code shows a heading with 'Oops! Page not found.' and a paragraph with a homepage link.

2. Step 2: Understand what Astro renders on missing pages

   Astro will display this content when a user visits a missing page.

3. Final Answer:

   A message saying 'Oops! Page not found.' with a link to homepage -> Option B

4. Quick Check:

   404 page shows friendly message + homepage link [OK]

Hint: 404 page content shows on missing pages [OK]

Common Mistakes:

• Expecting a blank page instead of message
• Confusing 404 with server error 500
• Thinking homepage content shows on 404

4. You created a 404.astro page but it does not show when visiting a missing page. What is the most likely mistake?

medium

A. The 404.astro file is inside the src/components folder

B. The file is named 404.html instead of 404.astro

C. The homepage link is missing inside the 404 page

D. The project does not have a package.json file

Solution

1. Step 1: Check file location requirements in Astro

   Astro expects 404.astro to be in the root of the src/pages folder, not inside components.

2. Step 2: Understand why wrong location breaks 404 page

   If placed in src/components, Astro won't serve it automatically as a 404 page.

3. Final Answer:

   The 404.astro file is inside the src/components folder -> Option A

4. Quick Check:

   404 page must be in pages folder [OK]

Hint: Place 404.astro in src/pages folder [OK]

Common Mistakes:

• Naming file 404.html instead of 404.astro
• Putting 404.astro in components folder
• Thinking missing homepage link breaks 404 page
• Assuming package.json affects 404 page

5. You want to create a custom error page in Astro that shows different messages for 404 and 500 errors. Which approach is best?

hard

A. Create separate 404.astro and 500.astro files in src/pages

B. Use only 404.astro and add JavaScript to detect 500 errors

C. Create a single error.astro file and rename it to 404.astro when needed

D. Handle errors only in client-side JavaScript, no Astro pages needed

Solution

1. Step 1: Understand Astro's error page handling

   Astro supports special files like 404.astro and 500.astro to handle different error codes automatically.

2. Step 2: Choose the best way to show different messages

   Creating separate files for 404 and 500 errors is clean and follows Astro conventions.

3. Final Answer:

   Create separate 404.astro and 500.astro files in src/pages -> Option A

4. Quick Check:

   Separate files for each error code [OK]

Hint: Use separate 404.astro and 500.astro files [OK]

Common Mistakes:

• Trying to detect errors with JavaScript in 404.astro
• Renaming files manually instead of separate files
• Ignoring server-side error handling