- 起步
- 核心概念
- 教程
- 基础内容
- 内置功能
- 集成
- 操作指南
- 使用指南
- 配置
- 参考
- 社区资源
- 其他
- 为文档做出贡献
- 手动安装 Astro
- 升级到 Astro v4
- 升级到 Astro v3
- 升级到 Astro v2
- Legacy v0.x Upgrade Guide
- 从 Create React App(CRA)迁移
- 关于本教程
- 第一单元:前期准备
- 准备开发环境
- 创建你的第一个 Astro 项目
- 你的第一行 Astro 代码
- 创建在线代码仓库
- 将你的网站部署到网络
- 第二单元:页面
- 创建你的第一个 Astro 页面
- 编写你的第一篇 Markdown 博客文章
- 添加「关于你」的动态内容
- 给你的「关于」页面添加样式
- 应用全局样式
- 第三单元:组件
- 创建一个可重复使用的导航组件
- 创建社交媒体 footer
- 自己动手搭建导航 Header
- 编写你的第一个浏览器脚本
- 第四单元:布局
- 编写你的第一个布局
- 创建并传递数据到博客布局
- 布局结合,两全其美
- 第五单元 - Astro API
- 创建文章存档页
- 生成标签页面
- 编写标签索引页面
- 添加 RSS 订阅源
- 第六单元 - Astro 群岛
- 搭建你的第一个 Astro 岛屿
- 回到干燥的陆地。让你的博客从白天到黑夜,无需岛屿!
- 恭喜你!
- @astrojs/mdx
- 添加阅读时间
- 创建开发者工具栏应用
- @astrojs/alpinejs
- @astrojs/lit
- @astrojs/preact
- @astrojs/react
- @astrojs/solid-js
- @astrojs/svelte
- @astrojs/vue
- @astrojs/cloudflare
- @astrojs/netlify
- @astrojs/node
- @astrojs/vercel
- @astrojs/db
- @astrojs/markdoc
- @astrojs/partytown
- @astrojs/sitemap
- @astrojs/tailwind
- 使用流式处理来提升页面性能
- 从 Gatsby 迁移
- 从 Next.js 迁移
- 从 NuxtJS 迁移
- 从 Docusaurus 迁移到 Astro
- 从 Eleventy 迁移到 Astro
- 从 GitBook 迁移到 Astro
- 从Gridsome迁移到Astro
- 从 Hugo 迁移
- 从 Jekyll 迁移
- 从 Pelican 迁移
- 从 SvelteKit 迁移
- 从VuePress迁移
- 从 WordPress 迁移
- 状态共享
- Storyblok 与 Astro
- Contentful 与 Astro
- ButterCMS & Astro
- Builder.io & Astro
- Cosmic 与 Astro
- DatoCMS 与 Astro
- Front Matter CMS 与 Astro
- Ghost & Astro
- Hashnode & Astro
- Hygraph 与 Astro
- Keystatic & Astro
- Kontent.ai 与 Astro
- 无头模式的 Statamic 与 Astro
- Strapi 与 Astro
- Tina CMS 与 Astro
- Umbraco & Astro
- 无头(headless)模式的 WordPress 与 Astro
- ApostropheCMS 与 Astro
- Caisy & Astro
- CloudCannon与Astro
- Crystallize 与 Astro
- Decap CMS 与 Astro
- Directus 与 Astro
- KeystoneJS 与 Astro
- microCMS & Astro
- Payload CMS 与 Astro
- Prepr CMS & Astro
- Prismic & Astro
- Sanity & Astro
- Sitecore 体验管理器 & Astro
- Spinal & Astro
- 创作内容
- Firebase 与 Astro
- Supabase 与 Astro
- Turso 和 Astro
- Xata 与 Astro
- Appwrite & Astro
- 部署你的 Astro 站点至 Netlify
- 部署你的 Astro 站点至 Vercel
- 如何将你的 Astro 网站部署到 Deno
- 部署你的 Astro 站点至 GitHub Pages
- 部署你的 Astro 站点至 GitLab Pages
- 部署你的 Astro 站点至 Cloudflare Pages
- 将你的 Astro 网站部署到 AWS
- 将你的 Astro 网站通过 Flightcontrol 部署到 AWS
- 将你的 Astro 网站通过 SST 部署到 AWS
- 将你的 Astro 网站部署至 Google Cloud
- 部署你的 Astro 站点至 Google Firebase 托管
- 将你的 Astro 网站部署到 Heroku
- 将你的 Astro 网站部署到 Microsoft Azure
- 部署你的 Astro 站点至 Buddy
- 将你的 Astro 网站部署到 Edgio
- 将你的 Astro 站点部署到 Fly.io
- 将你的 Astro 网站部署到 Render
- 将你的 Astro 网站部署到 Stormkit
- 将你的 Astro 网站部署到 Surge
- 通过 Cleavr 部署你的 Astro 网站
- 将你的 Astro 站点部署到 Kinsta 应用托管
- 将你的 Astro 网站部署到 Space
- 将你的 Astro 站点部署到 Zeabur
- 将你的 Astro 网站部署到 Zerops
- 添加 RSS 摘要
- 安装一个 Vite 或 Rollup 插件
- 构建自定义图像组件
- 使用 API 路由构建表单
- 在 Astro 页面中构建 HTML 表单
- 在 Astro 中使用 Bun
- 调用服务器端点
- 校验验证码
- 用 Docker 来构建你的 Astro 网站
- 动态导入图片
- 为链接添加图标
- 添加 i18n 功能
- 添加最后修改时间
- 在 Astro 组件中共享状态
- 使用 Tailwind Typography 美化渲染后的 Markdown
- Unknown compiler error.
- Astro.redirect is not available in static mode.
- Astro.clientAddress is not available in current adapter.
- Astro.clientAddress cannot be used inside prerendered routes.
- Astro.clientAddress is not available in static mode.
- No static path found for requested path.
- Invalid type returned by Astro page.
- Missing value for client:media directive.
- No matching renderer found.
- No client entrypoint specified in renderer.
- Missing hint on client:only directive.
- Invalid value returned by a getStaticPaths path.
- Invalid entry inside getStaticPath's return value
- Invalid value returned by getStaticPaths.
- getStaticPaths RSS helper is not available anymore.
- Missing params property on getStaticPaths route.
- Invalid value for getStaticPaths route parameter.
- getStaticPaths() function required for dynamic routes.
- Invalid slot name.
- Cannot use Server-side Rendering without an adapter.
- No import found for component.
- Invalid prerender export.
- Invalid component arguments.
- Page number param not found.
- Image missing required "alt" property.
- Error while loading image service.
- Missing image dimensions
- Failed to retrieve remote image dimensions
- Unsupported image format
- Unsupported image conversion
- Prerendered dynamic endpoint has path collision.
- Expected src to be an image.
- Expected image options.
- Cannot set both densities and widths
- Image not found.
- Could not process image metadata.
- Image not found.
- Could not transform image.
- Unable to set response.
- The middleware didn't return a Response.
- The middleware returned something that is not a Response object.
- The endpoint did not return a Response.
- Value assigned to locals is not accepted.
- Astro.response.headers must not be reassigned.
- Can't load the middleware.
- Local images must be imported.
- Astro.glob() used outside of an Astro file.
- Astro.glob() did not match any files.
- A redirect must be given a location with the Location header.
- Invalid dynamic route.
- Could not find Sharp.
- Unknown Vite Error.
- Could not import file.
- Invalid glob pattern.
- Astro couldn't find the correct page to render
- The provided locale does not exist.
- Index page not found.
- You can't use the current function with the current strategy
- Prerendered routes aren't supported when internationalization domains are enabled.
- 启用了手动国际化路由但没有提供中间件。
- Astro can't render the route.
- Unhandled rejection
- i18n Not Enabled
- Route not found.
- Unknown CSS Error
- CSS Syntax Error
- Unknown Markdown Error.
- Failed to parse Markdown frontmatter.
- Invalid frontmatter injection.
- MDX integration missing.
- Unknown configuration error.
- Specified configuration file not found.
- Legacy configuration detected.
- Unknown CLI Error.
- Failed to generate content types.
- Unknown Content Collection Error.
- Content entry frontmatter does not match schema.
- Invalid content entry slug.
- Content Schema should not contain slug.
- Collection does not exist
- Content and data cannot be in same collection.
- Collection contains entries of a different type.
- Data collection entry failed to parse.
- Duplicate content entry slug.
- Actions must be used with server output.
- Unsupported transform in content config.
导入
Astro 无需配置即支持大多数静态资源。你可以在项目的任何地方使用 import
语句(包括 Astro frontmatter 脚本),Astro 将在最终构建中内置优化后的静态资源副本。在 CSS 和 <style>
标签中也可以使用 @import
。
受支持的文件类型
下面的文件类型 Astro 开箱即用:
- Astro 组件 (
.astro
) - Markdown (
.md
,.markdown
,等等) - JavaScript (
.js
,.mjs
) - TypeScript (
.ts
,.tsx
) - NPM 包
- JSON (
.json
) - JSX (
.jsx
,.tsx
) - CSS (
.css
) - CSS 模块 (
.module.css
) - 图片和资源 (
.svg
,.jpg
,.png
,等等。)
此外,你可以扩展 Astro 以添加对不同 UI 框架的支持,如 React、Svelte 和 Vue 组件。你还可以安装 Astro MDX 集成并在项目中使用 .mdx
文件。
public/
中的文件
你可以将任何静态资源放在项目的 public/
目录中,Astro 将直接将其复制到最终构建中,而不会对其进行任何处理。public/
文件不会被 Astro 构建或打包,这意味着支持任何类型的文件。你可以在 HTML 模板中直接通过 URL 路径引用 public/
文件。
Import 语句
Astro 使用 ESM,它是浏览器中支持的相同 import
和 export
语法。
JavaScript
import { getUser } from './user.js';
可以使用普通的 ESM import
和 export
语法来导入 JavaScript。它在 Node.js 和浏览器中和预期保持一致。
TypeScript
import { getUser } from './user';
import type { UserType } from './user';
Astro 内置对 TypeScript 的支持。你可以在 Astro 项目中直接导入 .ts
和 .tsx
文件,甚至可以直接在 Astro 组件脚本和任意 hoisted script 标签 中编写 TypeScript 代码。
Astro 本身不进行任何类型检查。类型检查应该在 Astro 之外进行或由 IDE 或通过一个单独的脚本来处理。Astro VSCode 扩展 会自动为打开的文件中提供 TypeScript 提示和错误警告。或使用 astro check
命令 检查 Astro 文件的类型。
JSX / TSX
import { MyComponent } from './MyComponent.jsx';
Astro 内置对 JSX(*.jsx
和*.tsx
)文件的支持。JSX 语法会自动转译为 JavaScript。
虽然 Astro 能理解 JSX 语法,但你需要使用框架集成来正确渲染 React、Preact 和 Solid 等框架。请查看我们的使用集成指南以了解更多。
NPM 包
如果你安装了一个 NPM 包,你可以在 Astro 中导入它。
---
import { Icon } from 'astro-icon';
---
如果一个包使用了旧的格式发布,Astro 将尝试将包转换为 ESM,以便 import
语句可以正常工作。在某些情况下,你可能需要调整你的 vite
配置 以使其正常工作。
JSON
// 使用默认导入加载 JSON 对象
import json from './data.json';
Astro 支持直接在应用程序中导入 JSON 文件。导入文件会通过默认导入返回完整的 JSON 对象。
CSS
// 加载并将 'style.css' 注入到页面上。
import './style.css';
Astro 支持直接在应用程序中导入 CSS 文件。导入的样式没有暴露出口,但导入样式会自动将这些样式添加到页面中。它默认支持所有 CSS 文件,并且可以通过插件支持 CSS 编译语言,如 Sass & Less。
CSS 模块
// 1. 将 './style.module.css' 转换为类名唯一、有范围的值。
// 2. 返回对象,并将原始类名映射到其最终范围值的。
import styles from './style.module.css';
// This example uses JSX, but you can use CSS Modules with any framework.
return <div className={styles.error}>Your Error Message</div>;
Astro 支持使用 [name].module.css
命名约定的 CSS 模块。像导入任何 CSS 文件一样,导入 CSS 会应用到页面。然而,CSS 模块默认导出特殊的 styles
对象,并将你的原始类名映射到唯一的标识符。
CSS 模块帮助你在前端强制执行组件样式隔离,并生成唯一的样式表类名。
其他资源
import imgReference from './image.png'; // img === '/src/image.png'
import svgReference from './image.svg'; // svg === '/src/image.svg'
import txtReference from './words.txt'; // txt === '/src/words.txt'
// 这个例子使用 JSX,但你可以在任何框架下使用导入引用。
<img src={imgReference.src} alt="image description" />;
所有其他没有明确提到的资源可以通过 ESM 的 import
语句导入,并将返回最终构建中的资源引用连接。这对使用链接引用非 JS 资源很有用,比如创建一个带有 src
属性的图片元素指向该图片。
将图片放在 public/
文件夹中也很有用,这在项目结构页面中有所解释。
Astro.glob()
Astro.glob()
是一种一次性导入多个文件的方法。
Astro.glob()
只接受一个参数:一个相对的 glob 模式 匹配你想要导入的本地文件。它是异步的,并返回每个匹配文件的导出数组。
---
// 导入`./src/pages/post/` 中所有以 `.md` 结尾的文件
const posts = await Astro.glob('../pages/post/*.md');
---
<!-- 把前 5 篇博客文章渲染成 <article> -->
<div>
{posts.slice(0, 4).map((post) => (
<article>
<h2>{post.frontmatter.title}</h2>
<p>{post.frontmatter.description}</p>
<a href={post.url}>Read more</a>
</article>
))}
</div>
使用 Astro.glob
导入的 Astro 组件的类型为 AstroInstance
。你可以使用其 default
属性渲染每个组件实例:
---
// 导入`./src/components/` 中所有以 `.astro` 结尾的文件
const components = await Astro.glob('../components/*.astro');
---
<!-- 展示所有组件-->
{components.map((component) => (
<div> <component.default size={24} />
</div>
))}
Glob 模式
glob 模式是一个支持特殊通配符的文件路径。用于一次引用项目中的多个文件。
例如,glob 模式 ./pages/**/*.{md,mdx}
从 pages 子目录开始,查找其所有子目录(/**
),并匹配以 .md
或 .mdx
结尾的任何文件名(.{md,mdx}
)。
Astro 中的 Glob 模式
要与 Astro.glob()
一起使用,glob 模式必须是字符串字面量,并且不能包含任何变量。有关解决方法,请参阅故障排除指南。
此外,glob 模式必须以以下之一开头:
./
(从当前目录开始)../
(从父目录开始)/
(从项目根目录开始)
Astro.glob()
vs getCollection()
内容集合 提供用于加载多个文件的 getCollection()
API 代替 Astro.glob()
。如果你的内容文件 (例如 Markdown, MDX, Markdoc) 位于src/content/
目录内的集合中,使用 getCollection()
查询集合并返回内容条目。
WASM
// 加载并初始化所请求的 WASM 文件
const wasm = await WebAssembly.instantiateStreaming(fetch('/example.wasm'));
Astro 支持使用浏览器的 WebAssembly
API 直接在应用程序中 WASM 文件。
Node 内置模块
我们鼓励 Astro 用户尽可能避免使用 Node.js 内置模块(fs
、path
等)。Astro 兼容多个运行时使用 适配器。这包括 Deno 和 Cloudflare Workers,它们不支持 Node 内置模块,例如 fs
。
我们致力于为常用的 Node.js 内置模块提供 Astro 化的替代品,不过现在还没有实现。因此,如果你真的需要,我们不会阻止你使用这些内置模块。Astro 支持使用较新 node:
前缀来支持 Node.js 内置模块。例如,如果你想读取一个文件,你可以这样做:
---
// 示例:从 Node.js 中导入内置模块 "fs/promises"
import fs from 'node:fs/promises';
const url = new URL('../../package.json', import.meta.url);
const json = await fs.readFile(url, 'utf-8');
const data = JSON.parse(json);
---
<span>Version: {data.version}</span>
扩展文件类型支持
使用 Vite 和兼容的 Rollup 插件,你可以导入 Astro 原生不支持的文件类型。在 Vite 文档的查找插件 部分了解你需要的插件。
相关操作指南: 安装一个 Vite 或 Rollup 插件如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论