⚡️ Docusaurus 将帮助您立即发布一个漂亮的文档网站。

构建定制技术堆栈非常昂贵。相反，专注于您的内容并只编写 Markdown 文件。

准备好了解更多了吗？使用版本控制、i18n、搜索和主题自定义等高级功能。

检查最好的 Docusaurus 网站以获取灵感并阅读一些推荐。

Docusaurus 是一个静态站点生成器。它构建了一个具有快速客户端导航的单页面应用程序，利用React的全部功能使您的网站具有交互性。它提供开箱即用的文档功能，但可用于创建任何类型的网站（个人网站、产品、博客、营销登陆页面等）。

快速通道⏱️

通过玩5分钟了解Docusaurus ！

创建一个新的 Docusaurus 站点并遵循非常简短的嵌入式教程。

安装Node.js并创建一个新的 Docusaurus 站点：

npx create-docusaurus@latest my-website classic

启动站点：

cd my-website
npx docusaurus start

打开http://localhost:3000并按照教程进行操作。

Docusaurus 的构建高度重视开发人员和贡献者的体验。

• ⚛️使用 和 React 构建：使用 React 进行扩展和定制通过提供您自己的 React 组件来完全控制您网站的浏览体验
• 可插拔：使用基本模板引导您的网站，然后使用高级功能和插件开源您的插件以与社区分享
• ✂️开发者经验：立即开始编写您的文档通用配置入口点，使其更易于贡献者维护通过快速增量构建进行热重载更改基于路由的代码和数据拆分轻松发布到 GitHub Pages、Netlify、Vercel 和其他部署服务

我们的共同目标是帮助您的用户快速找到他们需要的东西并更好地了解您的产品。我们分享最佳实践，帮助您正确、良好地构建文档网站。

• SEO 友好：HTML 文件是为每个可能的路径静态生成的。特定于页面的 SEO 可帮助您的用户找到直接与他们手头的问题相关的官方文档。
• 由 MDX 提供支持：通过嵌入 Markdown 中的 JSX 和 React 编写交互式组件。在实时编辑器中分享您的代码，让您的用户当场爱上您的产品。
• 搜索：您的完整网站是可搜索的。
• 文档版本控制：帮助您保持文档与项目版本同步。
• 国际化 (i18n)：将您的网站翻译为多种语言环境。

Docusaurus 2 生来就适合所有用户，而且速度快如闪电。

• ⚡️快如闪电。Docusaurus 2 遵循PRPL 模式，确保您的内容加载速度极快。
• 无障碍。关注可访问性，使所有用户都可以平等地访问您的网站。

设计原则

• 学得很少。Docusaurus 应该易于学习和使用，因为 API 非常小。大多数事情仍然是用户可以实现的，即使需要花费更多的代码和更多的时间来编写。没有抽象比有错误的抽象更好，我们不希望用户不得不绕过错误的抽象。必讲——最小 API 表面积。
• 直观。用户在查看 Docusaurus 项目的项目目录或添加新功能时不会感到不知所措。它应该看起来直观且易于使用他们熟悉的方法进行构建。
• 分层架构。我们堆栈的每一层（内容/主题/样式）之间的关注点分离应该是清晰的——充分抽象和模块化。
• 合理的默认值。将为用户完成常见和流行的性能优化和配置，但他们可以选择覆盖它们。
• 没有供应商锁定。尽管强烈鼓励用户使用默认插件或 CSS，但并不要求用户使用默认插件或 CSS。某些核心基础设施（例如 React Loadable 和 React Router）无法交换，因为我们对它们进行了默认性能优化，但没有对更高级别的进行优化。Markdown 引擎、CSS 框架、CSS 方法论和其他架构的选择将完全取决于用户。

我们相信，作为开发人员，了解库的工作原理有助于我们更好地使用它。因此，我们致力于解释 Docusaurus 的架构和各个组件，希望阅读它的用户能够更深入地了解该工具并更加熟练地使用它。

与其他工具

在所有静态站点生成器中，Docusaurus 独特地关注文档站点，并具有许多开箱即用的功能。

我们还研究了其他主要的静态站点生成器，并希望分享我们对比较的见解，希望能帮助您浏览各种选择。

项目地址：

https://github.com/facebook/docusaurus