Skip to main content

Docusaurus Introduction

Docusaurus is a static site generator focused on documentation websites. It is built with React and Markdown, so you can write docs fast and still customize the UI deeply.

Why Use Docusaurus​

  • Fast documentation authoring with Markdown and MDX
  • Versioned docs support for product releases
  • Built-in blog and i18n support
  • Easy deployment to GitHub Pages, Netlify, Vercel, or your own server
  • Great developer experience with live reload

How It Works​

At a high level, Docusaurus reads your files from the docs and blog folders, applies theme and plugin configuration from docusaurus.config.ts, and generates static HTML/CSS/JS files in the build folder.

Flow:

  1. You create content in docs/ and blog/
  2. Docusaurus builds routes and sidebars
  3. Theme renders pages
  4. Static output is generated in build/

Core Concepts​

  • docs: Main documentation pages
  • sidebars: Navigation structure for docs
  • pages: Custom React pages in src/pages
  • static: Static assets copied as-is to output
  • plugins: Extend content types and behavior
  • themes: Control UI and rendering

When to Use It​

Use Docusaurus when you need:

  • Product documentation
  • Internal engineering knowledge base
  • API docs and guides
  • Multi-language docs websites