도큐사우루스 2020 요약
2020 was great for Docusaurus, despite a regrettable start and a tumultuous year for everyone.
We continued to invest in Docusaurus 2, and made it reach full feature parity with Docusaurus 1.
We now recommend Docusaurus 2 as the default choice to start a new Docusaurus project and encourage v1 users to migrate to Docusaurus 2.
We are still in alpha, but expect some good news very soon!
도큐사우루스 2에서 이런 걸 했습니다
우리는 올해 많은 기능을 작업했습니다. 그 중 중요한 몇몇을 정리해보고자 합니다.
- i18n: easily translate your Docusaurus site, released soon! (preview, doc)
- Version dropdown: enable contextual version switch
- Versioning options: solving the most common pain-points users had with versioning
- Contextual search: search in the current version, use the brand-new DocSearch 3 experience
- Markdown pages: use Markdown instead of React components to create standalone pages
- Better theme: various UI, UX and accessibility improvements
- PWA: add offline support to your site, and make it installable
- Fail-fast: strict config validation, detect broken links, and prevent bad production deployments
- Multi-instance: use the docs plugin twice on a single site (e.g. iOS/Android SDK docs)
- Migration CLI: automate the upgrade from Docusaurus 1
- CodeSandbox: assess Docusaurus easily from your browser with new.docusaurus.io
- Canary releases: use the
@canary
npm tag to use the upcoming release before anyone else - TypeScript: progressive adoption for internal code, and improve usage for users
- Publish Infima: it is now open-source
도큐사우루스 2가 이렇게 성장하고 있습니다
The plan to rebuild Docusaurus from scratch in 2019 paid off: after a slow start, Docusaurus 2 has been widely adopted and has already outgrown Docusaurus 1 usage.
Notable projects, startups, large companies, and individuals adopted Docusaurus 2 (showcase):
- Supabase
- React Navigation
- React Redux
- Vector
- Algolia DocSearch
- SAP Cloud SDK
- Palo Alto Cortex XSOAR
- Quddús George's website
We helped large scale Docusaurus 1 sites to upgrade, ensuring a proper migration path and feature parity.
React Native was successfully upgraded to Docusaurus 2 (archived v1 site):
Localized Docusaurus 1 sites (like Jest) will be able to upgrade too:
We also saw the first right-to-left Docusaurus 2 site published:
깃헙 활동
- Stars: 14632 → 20946 (+43.2% y/y)
- Total Contributors: 303 → 512 (+68.9% y/y). 대부분은 페이스북 소속이 아닌 기여자입니다.
- Weekly npm Downloads: 2356 → 25592 (+986% y/y)
- On GitHub, Docusaurus 1 is used by 6311 projects (+62.9% y/y) while Docusaurus 2 is used by 5039 projects (+1940% y/y)
메이저 리그 해킹 기여자와 협업
We have welcomed Major League Hacking (MLH) fellows for 2 seasons already.
We are very thankful for the various contributions they made, such as:
- v1에서 v2로 이전하기 위한 마이그레이션 CLI 기반 작업
- 리액트 네이티브 웹 사이트를 v1에서 v2로 이전하는데 기여
- 구성 유효성 체크를 좀 더 엄격하고 철저하게 만들고 유용한 에러 메시지를 반환하도록 작업
- 코드샌드박스 지원 추가
- CI 파이프라인 개선: 빌드 크기, 라이트하우스 봇
2021년에도 협업이 계속 이어지기를 기대합니다.
미디어
Dmitry Vinnik (Developer Advocate @ Facebook) explains Docusaurus in 60 seconds or 15min videos.
Rachel Nabors (Documentation Engineer @ Facebook) talked a bit about Docusaurus in React Native Radio 178 (podcast), and William Candillon the React Native website migration (video).
여러 블로그 포스트에서도 도큐사우루스를 다루어주었습니다.
- To the Makers of Docusaurus by Quddus George
- Richer API documentation with Redoc and Docusaurus by David Goss
- How to Build a Plugin for Docusaurus v2 by Adriaan Knapen
- React Tracked Documentation Website with Docusaurus v2 by Daishi Kato
- Easy documentation with Docusaurus by Anshul Goyal (MLH fellow)
- Build Beautiful Documentation Websites with Docusaurus by Victoria Lo
커뮤니티
The Docusaurus community continues to grow, the Discord server is quite active, and Stack Overflow questions keep being posted.
The modular architecture of Docusaurus 2 allowed the community to build and publish third-party plugins. As we would like to federate better our community, if you are building a plugin, please let us know.
다음 단계는 뭔가요?
As the core features of Docusaurus 2 have finally been built, we will be able to dedicate more time to solve the pain points and bugs reported by the community, and make Docusaurus stable and convenient enough to enter the beta and release-candidate phase.
With proper support for i18n and versioning, and large scale migrations such as React Native and Jest, we now have a clear migration path for all Docusaurus 1 sites.
We still have a few major features that we would like to work on:
- Create a theme gallery, make it easy to switch from one another, and include first-class Tailwind support
- Upgrade to Webpack 5, improve performances and build times
- Better compatibility with CommonMark, as MDX and makes it harder for CommonMark-based sites to adopt Docusaurus
- Upgrade to MDX 2.0
- 2021년에 발견될 다른 작업들
Huge thanks to the community for their contributions in 2020, especially:
- Joel Marcey for creating Docusaurus and supporting the project all this time
- the core team - Alexey Pyltsyn, Sébastien Lorber, Yangshun Tay
- 메이저 리그 해킹 그리고 페이스북 인턴 여러분의 눈에 띄는 작업
- DocSearch 3에 대한 Algolia 팀의 지원
- Bartosz Kaszubowski for his investment in the React Native migration
- 커뮤니티 기여자 모두에게 감사드립니다. 서로 격려해주세요.
2021년에도 다같이 힘내자구요! 🎉