Nov 30, 2020
ELI5: Docusaurus - Making Documentation Easy
By Dmitry Vinnik
Originally posted here.
In this post, we will briefly talk about Docusaurus, a website building tool that makes it easy to develop, maintain and deploy a documentation site. If you prefer to learn about Docusaurus in a short video rather than a blog post, go to the Facebook Open Source YouTube channel to watch another episode of ELI5.
The top open source projects on GitHub have their own documentation sites that contain an overview of the project, short getting started guides, in-depth tutorials and project blogs. These resources are key to the success of any open source project, but building, managing and deploying them can be a lot of work. Unless you're using Docusaurus.
Docusaurus is an open source project for building, deploying and maintaining websites. This project's main goal is to get you started with your website in a matter of seconds. Beyond creating the site, Docusaurus emphasizes speed of both developer and end users by following the PRPL pattern and by relying on an incremental build for content changes.
Docusaurus allows developers to use tools they already know like Markdown or MDX to write documentation or blogs. With React as the backbone of Docusaurus, developers can customize their website to fit their use case.
The cherry on top is that you don't have to manually update your documentation every time you update your code. Docusaurus automatically syncs docs to project releases so that you can spend more of your time working on the things you care about.
Where is it used?
Docusaurus was first released to the public by the Facebook Open Source team in 2017. Since then, this project has been used by a large number of the Facebook open source projects and by over 100 external projects.
Where can I learn more?
Want to learn more about Docusaurus? You can find extensive documentation and tutorials covering a wide range of topics on building and customizing your site. If you want to engage with the community, feel free to join the Discord channel or talk to the team on Twitter.
About the ELI5 series
In a series of short videos (~1 min in length), one of our Developer Advocates on the Facebook Open Source team explains a Facebook open source project in a way that is easy to understand and use.
We will write an accompanying blog post (like the one you're reading right now) for each of these videos, which you can find on our YouTube channel.
Interested in working with open source at Facebook? Check out our open source-related job postings on our career page by taking this quick survey.