docusaurus

Create a new Docusaurus site

$ npx create-docusaurus@latest [my-website] classic

$ npx docusaurus start

$ npx docusaurus build

$ npx docusaurus serve

$ npx docusaurus deploy

$ npx docusaurus clear

$ npx docusaurus docs:version [1.0]

npx docusaurus command [options]

Docusaurus is a static site generator optimized for documentation websites. It uses React for the UI, Markdown/MDX for content, and provides features like versioning, i18n, and search out of the box.
Sites are configured via docusaurus.config.js, defining metadata, themes, plugins, and navigation. Content lives in docs/ for documentation and blog/ for blog posts.
The development server provides hot reloading. Production builds generate static HTML, CSS, and JavaScript that can be hosted anywhere. Built-in deployment support targets GitHub Pages.

start [--port n]

Start development server (default port 3000).

Build static site for production.

Serve built site locally.

Deploy to GitHub Pages.

Clear generated files and caches.

Eject or wrap a theme component.

Create new documentation version.

Extract translatable strings.

Add heading IDs to markdown files.

Specify locale for command.

Use custom config file.

Requires Node.js 18+. Large sites may have slow build times. Custom React components need familiarity with React. Swizzling (customizing) theme components may break on upgrades. Search requires additional setup (Algolia or local search plugin).

Docusaurus was created at Facebook (Meta) and open-sourced in 2017. It was designed to power documentation for Facebook's open-source projects. Version 2, a complete rewrite using React, was released in 2022. The project is maintained by Meta and a community of contributors.

gatsby(1), vitepress(1), mkdocs(1), hugo(1)