#Docusaurus
7 posts
Build a Manual with Docusaurus #6: Maintenance — Search, Accessibility, and Documentation Culture
The final post in the series. We'll add search properly to Docusaurus, cover the accessibility that lets everyone read your docs, and the Docs as Code culture that keeps docs alive over time, laying out the operations perspective to close out the series.
Comparing Documentation Site Generators — Hugo, MkDocs, Docusaurus, Starlight: Which One to Pick
Once you've decided to build your team docs as a static site, the next question is which tool to build it with. We compare Hugo, MkDocs, Docusaurus, and Starlight across runtime, search, versioning, and ceiling, and lay out which to choose for which situation.
Build a Manual with Docusaurus #5: Multilingual and Versioning
We cover serving one set of docs in multiple languages, and keeping older docs alive as the product version climbs. With both multilingual and versioning available as built-in features, this is the area where Docusaurus is strongest.
Build a Manual with Docusaurus #4: Deploy to Cloudflare Pages and Connect a Domain
We send the docs you built locally out into the world. We'll push to GitHub, connect to Cloudflare Pages and set up the Node build, and attach a custom domain. We'll also touch on Docusaurus's built-in deploy command.
Build a Manual with Docusaurus #3: Writing Content — Code Blocks, Mermaid, Admonitions
We cover three elements that make docs easy to read: code blocks with titles and line highlighting, Mermaid diagrams drawn as code, and admonitions that surface cautions and warnings. Here's how to use each in Docusaurus.
Build a Manual with Docusaurus #2: Sidebar and Search — Structuring Your Documentation
When docs grow into dozens of pages, the sidebar and search are what keep readers from getting lost. We'll set up the sidebar in sidebars.js, both automatically and manually, and lay out your options for adding search in Docusaurus.
Build a Manual with Docusaurus #1: From Install to Your First Doc
Lay the foundation for a team docs or product manual site with Docusaurus. We'll go from setting up Node.js to creating a site with create-docusaurus and serving your first doc on the dev server, all in one pass.