ITADN
QwikDev/astro
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

Qwik logo

Qwik + Astro

Astro 中渲染 Qwik 组件。
零水合。即时交互。在用户需要之前保持为 HTML。

文档 · 报告问题 · Discord

快速开始

npm

npm create @qwik.dev/astro@latest

pnpm

pnpm create @qwik.dev/astro@latest

yarn

yarn create @qwik.dev/astro

bun

bun create @qwik.dev/astro

添加到现有项目

npm

npm create @qwik.dev/astro@latest add

pnpm

pnpm create @qwik.dev/astro@latest add

yarn

yarn create @qwik.dev/astro add

bun

bun create @qwik.dev/astro add

add 命令默认针对当前目录。传入路径,例如 npm create @qwik.dev/astro@latest add ./my-project,可将 Qwik 添加到不同的 Astro 应用。支持官方 Astro 模板以及许多社区启动器/主题

请参阅 CLI 文档 以获取所有可用命令和选项。

如需完整的安装说明、指南和 API 参考,请访问 qwik.dev/astro

从 v1 升级

这是 v2 分支(build/v2),在新 @qwik.dev/astro 包名称下支持 Qwik v2Astro 6+。如果你需要 Astro <5 或 Qwik v1,请使用 @qwikdev/astro 包(不带点)。

在你的项目目录中运行升级脚本:

npm create @qwik.dev/astro@latest upgrade

传入一个路径,例如 npm create @qwik.dev/astro@latest upgrade ./my-project 以升级不同的项目目录。

升级脚本会自动处理包替换和导入重写。但是,它不涵盖 Astro 特有的破坏性更改:

  • <ViewTransitions /> 已重命名为 <ClientRouter /> — Astro 重命名了此组件。请相应更新您的布局。

  • clientRouter 现在在集成配置中是必需的@qwik.dev/astro 要求您的 astro.config 中包含一个 clientRouter: true | false 属性:

    import qwik from "@qwik.dev/astro";
    
    export default defineConfig({
      integrations: [qwik({ clientRouter: true })],
    });

如果该脚本不适用于你的环境,请遵循手动升级指南

贡献

请参阅我们的贡献指南以开始。

帮助

请在Qwik Discord中联系我们,那里有一个专门的#qwik-astro频道。你也可以提交一个 issue

维护者