跳至主要内容

Docusaurus 2020 年回顾

·6 分钟阅读
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 版本:使用 @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 活动

  • Star 数: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 足够稳定和方便,以便进入Beta 和候选发布阶段

通过对i18n 和版本控制以及React NativeJest大规模迁移的支持,我们现在为所有 Docusaurus 1 网站提供了清晰的迁移路径。

我们还有几个主要功能想要开发

非常感谢社区在2020 年的贡献,尤其是

祝 2021 年一切顺利!🎉