title | description |
---|---|
页面 |
Astro 页面简介 |
import ReadMore from '/components/ReadMore.astro';
import Since from '/components/Since.astro'
页面是位于 Astro 项目的 src/pages/
子目录中的文件。它们负责处理路由、数据加载以及网站中每个页面的整体页面布局。
Astro 支持 src/pages/
目录中的以下文件类型:
Astro 使用一种名为 基于文件的路由 的路由策略。src/pages/
目录中的每个文件都会根据其文件路径成为网站上的一个端点。
一个文件也可以使用动态路由来生成多个页面。这允许你即使内容不在特殊的 /pages/
目录中,也可以创建页面,例如在内容集合或内容管理系统中。
了解更多关于 Astro 路由 的内容。
在你的 Astro 页面中,使用标准的 HTML <a>
元素来链接到网站上的其他页面。这需要使用 相对于根域名的 URL 路径 作为你的链接,而不是相对文件路径。
例如,要从 example.com
上的任何其他页面链接到 https://example.com/authors/sonali/
,你可以像这样:
阅读更多 <a href="/authors/sonali/">关于 Sonali 的信息</a>。
Astro 页面使用 .astro
文件扩展名,并支持与 Astro 组件相同的功能。
---
---
<html lang="en">
<head>
<title>我的主页</title>
</head>
<body>
<h1>欢迎来到我的网站</h1>
</body>
</html>
一个页面必须生成完整的 HTML 文档。如果没有显式包含,Astro 将会自动为位于 src/pages/
目录下的任何 .astro
组件默认添加必要的 <!DOCTYPE html>
声明和 <head>
内容。你可以通过将组件标记为局部页面来为每个组件避免这种行为。
为了避免在每个页面上重复相同的 HTML 元素,你可以将常见的 <head>
和 <body>
元素移动到自己的 布局组件 中。你可以使用任意多的布局组件。
---
// src/pages/index.astro
import MySiteLayout from '../layouts/MySiteLayout.astro';
---
<MySiteLayout>
<p>包裹在 layout 里的页面内容!</p>
</MySiteLayout>
了解更多关于 布局组件 的内容。
Astro 还将 src/pages/
目录中的任何 Markdown (.md
) 文件视为网站中的页面。如果你安装了 MDX 集成,它也会将 MDX (.mdx
) 文件视为相同的页面。这些通常用于像博客文章和文档这样的内容丰富的页面。
Markdown 或 MDX 页面内容的集合可以用来动态生成页面。
页面布局对于 Markdown 文件 特别有用。Markdown 文件可以使用特殊的 layout
前置属性来指定一个 布局组件,它将包装其 Markdown 内容在一个完整的 <html>...</html>
页面文档中。
---
# 举例:src/pages/page.md
layout: '../layouts/MySiteLayout.astro'
title: '我的 Markdown 页面'
---
# 标题
这是我的页面,使用 **Markdown** 编写。
了解更多关于 Astro 中的 Markdown 的内容。
.html
文件扩展名的文件可以放在 src/pages/
中,并直接用作网站上的页面。请注意,某些关键的 Astro 功能在 HTML 组件 中不受支持。
想要自定义 404 错误页面,你可以在 src/pages
中创建 404.astro
或 404.md
文件。
它将生成 404.html
页面。大多数部署服务都自动找到并使用它。
要为按需渲染的页面创建自定义的 500 错误页面,可以创建一个 src/pages/500.astro
文件。但这个自定义页面不适用于预渲染的页面,也不能被预渲染。
如果在渲染此页面时发生错误,将显示主机默认的 500 错误页面给访问者。
在开发过程中,如果你有一个 500.astro
文件,运行时抛出的错误将被记录在终端中,而不是显示在错误覆盖层中。
:::caution 局部页面是用于与前端库(如 htmx 或 Unpoly)搭配使用的。如果你习惯编写原生的前端 JavaScript,也可以使用它。这是一项高级功能。
如果组件包含有作用域的样式或脚本,那么不应该使用局部页面,因为这些元素将从 HTML 输出中剥离;如果需要有作用域的样式,最好使用常规的非局部的页面,并配合一个知道如何将内容合并到 head 标签中的前端库。 :::
局部页面是位于 src/pages/
目录中的页面组件,但不会作为完整页面进行渲染。
与位于此文件夹之外的组件一样,这些文件不会自动包含 <!DOCTYPE html>
声明,也不会包含任何作用域样式和脚本的 <head>
内容。
不过,由于它们位于特殊的 src/pages/
目录中,所以生成的 HTML 可以通过与文件路径相对应的 URL 来访问。这允许渲染库(如 htmx、Stimulus、jQuery 等)在客户端访问它,并在页面上动态加载 HTML 的部分,而无需刷新浏览器或进行页面导航。
局部页面与渲染库结合时,局部页面提供了一种可以代替 Astro 岛屿和 <script>
标签方式用于在 Astro 中构建动态内容的方法。
可以导出值(例如.astro
,.mdx
)的页面文件将被标记为局部页面。
通过添加以下导出项来将 src/pages/
目录中的文件配置为局部页面:
---
export const partial = true;
---
<li>我是一个局部页面!</li>
export const partial
必须是静态标识。它可以是以下值之一:
- 布尔值
true
。 - 使用
import.meta.env
的环境变量,如import.meta.env.USE_PARTIALS
。
局部页面用于使用诸如 htmx 的库动态更新页面的某个部分。
下面的示例展示了将 hx-post
属性设置为局部页面的 URL。局部页面的内容将用于更新此页面上目标 HTML 元素的内容。
<html>
<head>
<title>我的页面</title>
<script src="https://unpkg.com/[email protected]"
integrity="sha384-FhXw7b6AlE/jyjlZH5iHa/tTe9EpJ1Y55RjcgPbjeWMskSxZt1v9qkxLJWNJaGni"
crossorigin="anonymous"></script>
</head>
</html>
<section>
<div id="parent-div">目标在这</div>
<button hx-post="/partials/clicked/"
hx-trigger="click"
hx-target="#parent-div"
hx-swap="innerHTML"
>
点我!
</button>
</section>
.astro
局部页面必须在相应的文件路径中存在,并且包含一个导出定义将页面定义为局部页面:
---
export const partial = true;
---
<div>我被点击了!</div>
参见 htmx 文档以了解更多关于使用 htmx 的细节。