跳到主要内容

Docusaurus 2020 回顾

·阅读时长7分钟
Sébastien Lorber
Sébastien Lorber
Docusaurus 维护者，《本周 React》编辑

尽管经历了一个令人遗憾的开始以及对每个人来说都动荡不安的一年，2020 年对 Docusaurus 来说是伟大的一年。

我们持续投入开发 Docusaurus 2，并使其与 Docusaurus 1 达到了完整功能对等。

我们现在**推荐 Docusaurus 2** 作为启动新 Docusaurus 项目的**默认选择**，并鼓励 v1 用户迁移到 Docusaurus 2。

我们仍处于 alpha 阶段，但预计很快就会有好消息！

Three Docusaurus plushies laid side-by-side on the table

Docusaurus 2 亮点​

今年我们开发了许多功能，并希望突出其中最重要的部分：

  • i18n：轻松翻译您的 Docusaurus 站点，即将发布！（预览，文档）
  • 版本下拉菜单：启用上下文版本切换
  • 版本控制选项：解决用户在版本控制方面最常见的痛点
  • 上下文搜索：在当前版本中搜索，使用全新的 DocSearch 3 体验
  • Markdown 页面：使用 Markdown 而非 React 组件创建独立页面
  • 更佳主题：各种 UI、UX 和可访问性改进
  • PWA：为您的站点添加离线支持，并使其可安装
  • 快速失败：严格的配置验证，检测断开链接，并防止错误的生产部署
  • 多实例：在单个站点上两次使用文档插件（例如 iOS/Android SDK 文档）
  • 迁移 CLI：自动化从 Docusaurus 1 的升级
  • CodeSandbox：通过 new.docusaurus.io 轻松在浏览器中评估 Docusaurus
  • 金丝雀发布：使用 @canary npm 标签，在其他人之前使用即将发布的版本
  • TypeScript：内部代码的渐进式采用，并改善用户使用体验
  • 发布 Infima：现已开源

Docusaurus 2 增长​

2019 年从头重建 Docusaurus 的计划取得了成效：经过缓慢的启动后，Docusaurus 2 已被广泛采用，并**已超越 Docusaurus 1** 的使用量。

Docusaurus v1 vs. v2 npm trends of the year 2020. The installations of Docusaurus v2 is visibly up-growing, while v1 is slightly downward. V1 starts at 15000 and ends at 10000, while v2 starts at 2000 and ends at 25000. The intersection happens around June 2020.

知名的**项目、初创公司、大型企业和个人**已采用 Docusaurus 2（展示）

我们帮助**大型 Docusaurus 1 站点进行升级**，确保了适当的**迁移路径**和**功能对等**。

React Native 已成功升级到 Docusaurus 2（v1 站点存档）

React Native's new website built with Docusaurus v2

本地化的 Docusaurus 1 站点（如 **Jest**）也将能够升级

Jest's new website built with Docusaurus v2 in Japanese

我们还看到了第一个从右到左的 Docusaurus 2 站点发布

Datagit's website in Persian, a right-to-left language. The sidebar appears on the right of the window and the TOC appears on the left.

GitHub 活动​

  • 星标：14632 → 20946（同比+43.2%）
  • 总贡献者：303 → 512（同比+68.9%）。其中大多数是非 Facebook 贡献者
  • 每周 npm 下载量：2356 → 25592（同比+986%）
  • 在 GitHub 上，Docusaurus 1 被 6311 个项目使用（同比+62.9%），而 Docusaurus 2 被 5039 个项目使用（同比+1940%）

与 Major League Hacking 的合作​

我们已经连续两个赛季欢迎 Major League Hacking (MLH) 研究员。

我们非常感谢他们所做的各种贡献，例如：

  • 撰写 v1 到 v2 迁移 CLI 的基础
  • 帮助将 React Native 网站从 v1 迁移到 v2
  • 使配置验证更严格和详尽，并返回有用的错误消息
  • 添加 CodeSandbox 支持
  • 改进 CI 管道：构建大小和 Lighthouse 机器人

我们期待在 2021 年继续这项合作。

媒体​

Dmitry Vinnik（Facebook 开发人员倡导者）在60 秒或15 分钟的视频中解释了 Docusaurus。

Rachel Nabors（Facebook 文档工程师）在React Native Radio 178（播客）中简要介绍了 Docusaurus，William Candillon 谈到了React Native 网站迁移（视频）。

许多博客文章已发布

社区​

Docusaurus 社区持续发展，Discord 服务器非常活跃，并且 Stack Overflow 上的问题不断发布。

Docusaurus 2 的**模块化架构**使得社区能够构建并发布第三方插件。为了更好地团结我们的社区，如果您正在构建插件，请告知我们。

下一步是什么？​

随着 Docusaurus 2 的**核心功能**最终构建完成，我们将能够投入更多时间解决社区报告的痛点和错误，使 Docusaurus 足够稳定和方便，以进入**测试版和发布候选阶段**。

通过对 **i18n 和版本控制**的适当支持，以及**大规模迁移**（例如 **React Native** 和 **Jest**），我们现在为所有 Docusaurus 1 站点提供了清晰的迁移路径。

我们仍有一些希望开发的主要功能：

非常感谢社区在2020 年的贡献，特别是：

  • Joel Marcey 创造了 Docusaurus 并一直支持该项目
  • 核心团队 - Alexey Pyltsyn、Sébastien Lorber、Yangshun Tay
  • Major League Hacking 和 Facebook 实习生，感谢他们的重大影响
  • Algolia 团队，感谢他们的 DocSearch 3 和支持
  • Bartosz Kaszubowski，感谢他对 React Native 迁移的投入
  • 整个社区，感谢他们的贡献和相互支持

为美好的 2021 欢呼！🎉