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 活动
- 星标 : 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的创造者 by Quddus George
- 使用Redoc和Docusaurus创建更丰富的API文档 by David Goss
- 如何为Docusaurus v2构建插件 by Adriaan Knapen
- 使用Docusaurus v2的React Tracked文档网站 by Daishi Kato
- 使用Docusaurus轻松编写文档 by Anshul Goyal (MLH fellow)
- 使用Docusaurus构建漂亮的文档网站 by Victoria Lo
社区
Docusaurus社区继续发展壮大, Discord 服务器非常活跃,并且不断发布 Stack Overflow问题 。
Docusaurus 2的 模块化架构 允许社区构建和发布 第三方插件 。由于我们希望更好地联合我们的社区,如果您正在构建插件,请 告知我们 。
接下来的计划
由于 Docusaurus 2的核心功能 最终已经构建完成,我们将能够投入更多时间来解决社区报告的痛点和错误,并使Docusaurus足够稳定和方便,从而进入 测试版和候选发布阶段 。
通过对 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年一切顺利!🎉