Skip to content

从 Docusaurus 迁移

Docusaurus 是一个基于 React 的流行文档网站构建器。

¥Docusaurus is a popular documentation website builder built on React.

Docusaurus 和 Astro 之间的主要相似之处

Section titled Docusaurus 和 Astro 之间的主要相似之处

¥Key Similarities between Docusaurus and Astro

Docusaurus 和 Astro 有一些相似之处,可以帮助你迁移项目:

¥Docusaurus and Astro share some similarities that will help you migrate your project:

  • Astro 和 Docusaurus 都是现代的、基于 JavaScript (Jamstack) 的网站构建器,旨在用于 内容驱动的网站,例如文档网站。

  • Astro 和 Docusaurus 都支持 MDX 页面。你应该能够将现有的 .mdx 文件用于 Astro。

  • Astro 和 Docusaurus 都使用 基于文件的路由 为位于 src/pages 中的任何 MDX 文件自动生成页面路由。将 Astro 的文件结构用于现有内容以及添加新页面时应该感觉很熟悉。

  • Astro 有一辆 使用 React 组件的官方集成。请注意,在 Astro 中,React 文件必须具有 .jsx.tsx 扩展名。

  • Astro 支持 安装 NPM 包,包括一些针对 React 的支持。你也许可以保留部分或全部现有的 React 组件和依赖。

  • 如果你习惯编写 React,那么 Astro 类似 JSX 的语法 应该感觉很熟悉。

Docusaurus 和 Astro 之间的主要区别

Section titled Docusaurus 和 Astro 之间的主要区别

¥Key Differences between Docusaurus and Astro

当你在 Astro 中重建 Docusaurus 站点时,你会注意到一些重要的差异:

¥When you rebuild your Docusaurus site in Astro, you will notice some important differences:

  • Docusaurus 是一个基于 React 的单页应用 (SPA)。Astro 网站是使用 .astro 组件 构建的多页面应用,但也可以支持 React、Preact、Vue.js、Svelte、SolidJS、AlpineJS、Lit 和原始 HTML 模板。

  • Docusaurus 旨在构建文档网站,并具有一些内置的、特定于文档的网站功能,你必须在 Astro 中自行构建这些功能。相反,Astro 通过 Starlight:官方文档主题 提供了其中一些功能。该网站是 Starlight 的灵感来源,现在在其上运行!你还可以在我们的主题展示中找到更多具有内置功能的 社区文档主题

  • Docusaurus 网站使用 MDX 页面来获取内容。Astro 的文档主题默认使用 Markdown (.md) 文件,并且不要求你使用 MDX。除了标准 Markdown 文件之外,你还可以选择 安装 Astro 的 MDX 集成(默认包含在我们的 Starlight 主题中)并使用 .mdx 文件。

从 Docusaurus 切换到 Astro

Section titled 从 Docusaurus 切换到 Astro

¥Switch from Docusaurus to Astro

要将 Docusaurus 文档站点转换为 Astro,请从我们的官方 星光文档主题入门模板 开始,或在我们的 主题展示 中探索更多社区文档主题。

¥To convert a Docusaurus documentation site to Astro, start with our official Starlight docs theme starter template, or explore more community docs themes in our theme showcase.

你可以将 --template 参数传递给 create astro 命令,以使用我们的官方启动器之一启动一个新的 Astro 项目。或者,你可以 从 GitHub 上任何现有的 Astro 存储库启动一个新项目

¥You can pass a --template argument to the create astro command to start a new Astro project with one of our official starters. Or, you can start a new project from any existing Astro repository on GitHub.

Terminal window
npm create astro@latest -- --template starlight

Astro 的 MDX 集成默认包含在内,因此你可以立即 将你现有的内容文件带到 Starlight

¥Astro’s MDX integration is included by default, so you can bring your existing content files to Starlight right away.

你可以在 astro.new 上找到 Astro 的文档入门和其他官方模板。你将找到每个项目的 GitHub 存储库的链接,以及用于在 StackBlitz、CodeSandbox 和 Gitpod 在线开发环境中打开工作项目的一键链接。

¥You can find Astro’s docs starter, and other official templates, on astro.new. You’ll find a link to each project’s GitHub repository, as well as one-click links to open a working project in StackBlitz, CodeSandbox and Gitpod online development environments.

¥Community Resources

  • 添加你自己的!

More migration guides

Astro 中文网 - 粤ICP备13048890号