Docusaurus
sashimi.docusaurus
A Docker Compose file for Docusaurus alone, generated from the catalog and checked by the safety inspector. No account needed.
Documentation site generator built on React and MDX, with versioned docs, i18n, automatic sidebars and search, producing a static site that can embed interactive components.
Docusaurus renders Markdown and MDX into a static React site, which means a documentation page can contain a live component — a running example, a tabbed code sample, an interactive diagram — rather than only a screenshot of one. Documentation versioning is built in, so a released version's pages are frozen while the next version is edited, and internationalisation manages parallel translated trees of the same content. Sidebars can be generated from the file structure or declared explicitly, and a blog section with tags and RSS ships alongside the docs. The output is plain static files served by any web server.
You know it worked when
- The development server starts and the site loads in a browser.
- A Markdown change appears without a manual rebuild.
- The generated sidebar lists every page in the docs directory.
- A production build completes with no broken-link errors.
- A versioned copy of the docs is reachable under its own path.
Known sharp edges
- Broken internal links fail the production build by default, so a build can succeed locally and stop in CI after an unrelated page is renamed.
- MDX is stricter than plain Markdown and treats stray angle brackets and braces as JSX, which breaks pages that were fine in another generator.
- Versioning copies the entire documentation tree per released version, so the repository and build time grow with each version retained.
- Search is not built in — it requires either a hosted index or a local search plugin configured separately.