跳转到内容

从 Docusaurus 迁移到 Astro

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

Docusaurus 和 Astro 之间的主要相似点

段落标题 Docusaurus 和 Astro 之间的主要相似点

Docusaurus 和 Astro 之间有一些相似之处,这将有助于你迁移你的项目:

  • 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 组件和依赖项。

  • Astro 的类 JSX 语法 如果你习惯写 React 应该会感觉很熟悉。

Docusaurus 和 Astro 之间的主要区别

段落标题 Docusaurus 和 Astro 之间的主要区别

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

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

  • Docusaurus 设计用于构建文档网站,并且有一些内置的,特定于文档的网站功能,你需要在 Astro 中自己构建。相反,Astro 通过 Starlight:官方文档主题 提供其中一些功能。本网站就是 Starlight 的灵感来源,并且它现在就运行在上面!你还可以在我们的主题展示中找到更多具有内置功能的 社区文档主题

  • Docusaurus 站点使用 MDX 页面进行内容。Astro 的文档主题默认使用 Markdown(.md) 文件,并不需要你使用 MDX。你可以选择 安装 Astro 的 MDX 集成 (默认包含在我们的 Starlight 主题中) 并使用.mdx文件作为标准 Markdown 文件。

从 Docusaurus 切换到 Astro

段落标题 从 Docusaurus 切换到 Astro

要把一个 Docusaurus 文档站点转换为 Astro,首先使用我们的官方 Starlight 文档主题启动模板,或者在我们的 主题展示 中探索更多社区文档主题。

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

终端窗口
npm create astro@latest -- --template starlight

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

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

  • 添加你自己的!

More migration guides

Contribute

What’s on your mind?

Create GitHub Issue

Quickest way to alert our team of a problem.

Community