Docusaurus Tinkering Notes
What Docusaurus is, what it can do, and how I tinkered with it as a documentation site.
On this page
#What is Docusaurus (the Document Dragon) 🦖?
Docusaurus is an open-source static site generator, led by Facebook and built on the React framework. It makes it easy to build modern, responsive static websites. In the official slogan's words, it is for "quickly building content-centric websites."
Docusaurus is a compound word made of Document + Dinosaurs, so it can be translated literally as "Document Dragon" (compound words like this are really hard to pronounce). It's an American pun, a bit like a parody of a well-known comedy troupe's name.
- Docusaurus GitHub repository
- Official docs
#What can Docusaurus do?
- Provides documentation features such as versioning, search, and syntax highlighting.
- Supports a blog feature, so you can quickly set up a blog.
- Theme system: customize the look of your theme. See case studies.
- Plugin system: extend with plugins.
- Built-in SEO support, so search engines can crawl it easily.
- Works out of the box with simple configuration.
- An active community, open-sourced by Facebook.
- Multilingual support, so you can build a globally accessible site.
info If your product is building a help documentation center for users around the world, then the Document Dragon should be your only choice.
#How to install Docusaurus?
TODO