Docusaurus 2020 年回顾
2020 年对 Docusaurus 来说是伟大的一年,尽管开局令人遗憾,并且对每个人来说都是动荡的一年。
我们继续投资于Docusaurus 2,并使其达到与Docusaurus 1完全相同的特性。
我们现在建议将 Docusaurus 2 作为默认选择来开始新的 Docusaurus 项目,并鼓励 v1 用户迁移到 Docusaurus 2。
我们仍处于 alpha 阶段,但预计很快就会有喜讯!
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 2(展示)
- Supabase
- React Navigation
- React Redux
- Vector
- Algolia DocSearch
- SAP Cloud SDK
- Palo Alto Cortex XSOAR
- Quddús George 的网站
我们帮助大型 Docusaurus 1 网站进行了升级,确保了正确的迁移路径和功能一致性。
React Native 已成功升级到 Docusaurus 2(已归档的 v1 网站)
本地化的 Docusaurus 1 网站(如Jest)也将能够升级
我们还看到了第一个从右到左的 Docusaurus 2 网站发布
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 的开发者,作者:Quddus George
- 使用 Redoc 和 Docusaurus 构建更丰富的 API 文档,作者:David Goss
- 如何为 Docusaurus v2 构建插件,作者:Adriaan Knapen
- 使用 Docusaurus v2 构建 React 追踪文档网站,作者:Daishi Kato
- 使用 Docusaurus 简化文档,作者:Anshul Goyal(MLH 学员)
- 使用 Docusaurus 构建漂亮的文档网站,作者:Victoria Lo
社区
Docusaurus 社区不断发展壮大,Discord 服务器非常活跃,并且Stack Overflow 问题不断涌现。
Docusaurus 2 的模块化架构使社区能够构建和发布第三方插件。由于我们希望更好地联合我们的社区,如果您正在构建插件,请告知我们。
接下来是什么?
随着Docusaurus 2 的核心功能最终构建完成,我们将能够投入更多时间来解决社区报告的问题和错误,并使 Docusaurus 足够稳定和方便,以便进入Beta 和候选发布阶段。
通过对i18n 和版本控制以及React Native和Jest等大规模迁移的支持,我们现在为所有 Docusaurus 1 网站提供了清晰的迁移路径。
我们还有几个主要功能想要开发
- 创建一个主题库,使其易于相互切换,并包含一流的 Tailwind 支持
- 升级到 Webpack 5,提高性能和构建时间
- 更好地兼容 CommonMark,因为 MDX 使基于 CommonMark 的站点更难采用 Docusaurus
- 升级到 MDX 2.0
- 我们在 2021 年可能会发现的其他任务
非常感谢社区在2020 年的贡献,尤其是
- Joel Marcey 创建了 Docusaurus 并一直支持该项目
- 核心团队 - Alexey Pyltsyn、Sébastien Lorber、Yangshun Tay
- Major League Hacking 和 Facebook 实习生对项目做出的重大贡献
- Algolia 团队为 DocSearch 3 及其支持
- Bartosz Kaszubowski 对 React Native 迁移的投入
- 整个社区的贡献,以及他们互相提供的支持
祝 2021 年一切顺利!🎉