The document discusses Docusaurus, an open source documentation website generator. It summarizes that Docusaurus makes documentation easy by allowing users to write docs in Markdown and generate static HTML files. It also supports features like search, localization, versioning and customization through React extensions. The document demonstrates how large open source projects like React Native and Babel use Docusaurus for their documentation. It previews upcoming changes in Docusaurus 2 that will improve extensibility. The goal of Docusaurus is to encourage open source maintainers to prioritize documentation.
From Event to Action: Accelerate Your Decision Making with Real-Time Automation
Painless Docs with Docusaurus
1. Painless Open Source Documentation
with Docusaurus
Yangshun Tay | Front End Engineer
2. Docusaurus
Yangshun Tay, Front End
Engineer
Getting to Know You
• How many of you are project maintainers?
• How many of you have a website for your project?
• How many of you built your own website?
• How many of you built your own website but thought it was very time
consuming?
6. Docusaurus
Yangshun Tay, Front End
Engineer
Documentation Helps Success?
• 17 of the top 20 (85%) most followed GitHub projects have a
website
• 3 more are documentation repos via README.md
• The 17th project (create-react-app) just created a website
9. Docusaurus
Yangshun Tay, Front End
Engineer
Documentation Helps Success?
• Isn't creating a website time consuming?
• Isn't writing documentation hard?
• Isn't it hard to add useful features?
Slash says "No!"
13. Docusaurus
Yangshun Tay, Front End
Engineer
Save time and focus on your project's documentation. Simply
write docs and blog posts with Markdown and Docusaurus
will generate a set of static html files ready to be served.
14. Docusaurus
Yangshun Tay, Front End
Engineer
Make it easy for your community to find what they need in
your documentation. We proudly support Algolia
documentation search.
15. Docusaurus
Yangshun Tay, Front End
Engineer
Localization comes pre-configured. Use Crowdin to
translate your docs into over 70 languages.
16. Docusaurus
Yangshun Tay, Front End
Engineer
Change the look and feel of your project pages by using
React. Docusaurus can be extended while reusing the same
header and footer.
17. Docusaurus
Yangshun Tay, Front End
Engineer
Support users on all versions of your project.
Document versioning helps you keep documentation in sync
with project releases.
18. Docusaurus
Yangshun Tay, Front End
Engineer
Docusaurus by the Numbers
• Started on Jun 2017
• Launched on Dec 14 2017
• 1000+ projects using
• 9249 stars
36. Docusaurus
Yangshun Tay, Front End
Engineer
V1 (Website) V2 (Single Page App)
Rendering Purely server side
Server side (initial load)
Client side (subsequent page transitions)
Versioning Diff-based approach Snapshot-based approach
Styles
Traditional CSS
Lives in vendor land
CSS Modules / Sass
Lives in user land
Layout Fixed Customizable
Themes No Yes! Via CSS variables (?)
Routing Express React Router + SSR
Bundling Custom scripts Webpack
39. Docusaurus
Yangshun Tay, Front End
Engineer
We just want open source project owners to consider
documentation as first-class component to their project
41. Docusaurus
Yangshun Tay, Front End
Engineer
What did we learn?
• Docusaurus makes it really simple to create a website
• v1 provides common features out of the box
• v2 will have the best qualities of v1 but even more extensible
• Docusaurus is building a community of small and large sites
alike
Docs can be fun!
42. Docusaurus
Yangshun Tay, Front End
Engineer
Docusaurus Maintainers
Yangshun Tay Joel Marcey Endilie Yacop Sucipto
@JoelMarcey
JoelMarcey
@endiliey@yangshunz
yangshun endiliey
43. Docusaurus
Yangshun Tay, Front End
Engineer
Project Information
Slash
@docusaurus
facebook/docusaurus
#docusaurus-users
#docusaurus-dev