0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
astro/docs/core-concepts/astro-pages.md
2021-07-07 20:10:09 +00:00

2.9 KiB

layout title
~/layouts/Main.astro Astro Pages

Pages are a special type of Astro Component that handle routing, data loading, and templating for each page of your website. You can think of them like any other Astro component, just with extra responsibilities.

Astro also supports Markdown for content-heavy pages, like blog posts and documentation. See Markdown Content for more information on writing pages with Markdown.

File-based Routing

Astro uses Pages to do something called file-based routing. Every file in your src/pages directory becomes a page on your site, using the file name to decide the final route.

Astro Components (.astro) and Markdown Files (.md) are the only supported formats for pages. Other page types (like a .jsx React component) are not supported, but you can use anything as a UI component inside of an .astro page to achieve a similar result.

Examples

src/pages/index.astro       -> mysite.com/
src/pages/about.astro       -> mysite.com/about
src/pages/about/index.astro -> mysite.com/about
src/pages/about/me.astro    -> mysite.com/about/me
src/pages/posts/1.md        -> mysite.com/posts/1

Data Loading

Astro pages can fetch data to help generate your pages. Astro provides two different tools to pages to help you do this: fetch() and top-level await.

---
// Example: Astro component scripts run at build time
const response = await fetch('http://example.com/movies.json');
const data = await response.json();
console.log(data);
---
<!-- Output the result to the page -->
<div>{JSON.stringify(data)}</div>

fetch()

Astro pages have access to the global fetch() function in their setup script. fetch() is a native JavaScript API (MDN) that lets you make HTTP requests for things like APIs and resources.

Even though Astro component scripts run inside of Node.js (and not in the browser) Astro provides this native API so that you can fetch data at page build time.

Top-level await

await is another native JavaScript feature that lets you await the response of some asynchronous promise (MDN). Astro supports await in the top-level of your component script.

Page Templating

All Astro components are responsible for returning HTML. Astro Pages return HTML as well, but have the unique responsibility of returning a full <html>...</html> page response, including <head> (MDN) and <body> (MDN).

<!doctype html> is optional, and will be added automatically.

---
// Example: HTML page skeleton
---
<!doctype html>
<html>
  <head>
    <title>Document title</title>
  </head>
  <body>
    <h1>Hello, world!</h1>
  </body>
</html>