← All resources
The toolkit · Resource guide

Docusaurus

Build a documentation website using a React-based static site framework.

Visit website (opens in a new tab)
Understand the tool

Overview

Build a documentation website using a React-based static site framework.

Evaluate it against your publishing, design or development requirements before committing a project to its workflow.

Best for

  • Working with documentation versioning.
  • Exploring markdown content.
  • Comparing search integrations with your project requirements.

Key features

  • Documentation versioning
  • Markdown content
  • Search integrations
A practical walkthrough

Getting started

  1. Define the requirement. Compare your content, integration and deployment needs with the official platform information.

  2. Build a small proof of concept. Try documentation versioning with sample content.

  3. Review the tradeoffs. Check maintenance, portability, accessibility and costs before adopting it.

Things to know

  • Hosted plans and self-hosted software have different responsibilities.
  • Check export, backup and integration requirements.
  • A platform choice does not remove the need for ongoing maintenance.

Useful alongside this

Accessibility

Text

Visual

Orientation

Accessibility settings