Docusaurus: Build Documentation Sites

Shriira Press

Preface

Build a fast, modern documentation website from Markdown — with docs, versioning, search, and React — using Docusaurus.

Welcome to Docusaurus: Build Documentation Sites.

A practical, in-depth guide to Docusaurus, the open-source static site generator optimized for documentation. Learn how to build and maintain a great docs site: the documentation site problem, the React-powered SSG architecture (plugins, themes, presets), authoring in Markdown and MDX, docs/sidebars/versioning, theming and customization (config, CSS, swizzling), search/i18n/plugins, building and deploying static sites (docs as code), operations and maintenance, and Docusaurus in practice.

This title is part of the ShriIra library and is free to read in full, right here — our small contribution to making world-class knowledge easy to reach.

A note on reading it: open the Contents menu at the top of the reader to jump between chapters, use the Aa menu to set a comfortable text size, theme (light, sepia, or night), and single- or two-page layout. Your place is saved automatically, so you can always pick up where you left off.

We hope it serves you well.

— Shriira Press

Contents

  1. Chapter 1 — What Docusaurus Is
  2. Chapter 2 — The Documentation Site Problem
  3. Chapter 3 — Architecture
  4. Chapter 4 — Content — Markdown and MDX
  5. Chapter 5 — Docs, Sidebars, and Versioning
  6. Chapter 6 — Theming and Customization
  7. Chapter 7 — Search, i18n, and Plugins
  8. Chapter 8 — Building and Deploying
  9. Chapter 9 — Operations and Maintenance
  10. Chapter 10 — Docusaurus in Practice
0%
1/1