Introduction

āš”ļø Docusaurus will help you ship a beautiful documentation site in no time.

šŸ’ø Building a custom tech stack is expensive. Instead, focus on your content and just write Markdown files.

šŸ’„ Ready for more? Use advanced features like versioning, i18n, search and theme customizations.

šŸ’… Check the best Docusaurus sites for inspiration and read some testimonials.

šŸ§ Docusaurus is a static-site generator. It builds a single-page application with fast client-side navigation, leveraging the full power of React to make your site interactive. It provides out-of-the-box documentation features but can be used to create any kind of site (personal website, product, blog, marketing landing pages, etc).

cd my-website
npx docusaurus start
Fast Track ā±ļø

Understand Docusaurus in 5 minutes by playing!

Create a new Docusaurus site and follow the very short embedded tutorial.

Install Node.js and create a new Docusaurus site:

Disclaimer

Docusaurus v2 is beta but already quite stable and widely used.

We highly encourage you to use Docusaurus v2 over Docusaurus v1, as Docusaurus v1 will be deprecated soon.

A lot of users are already using Docusaurus v2 (trends).

Use Docusaurus v2 if:

  • āœ… You want a modern Jamstack documentation site
  • āœ… You want a single-page application (SPA) with client-side routing
  • āœ… You want the full power of React and MDX
  • āœ… You do not need support for IE11
Design principles

Docusaurus v2 is beta but already quite stable and widely used.

We highly encourage you to use Docusaurus v2 over Docusaurus v1, as Docusaurus v1 will be deprecated soon.

A lot of users are already using Docusaurus v2 (trends).

Use Docusaurus v2 if:

  • āœ… You want a modern Jamstack documentation site
  • āœ… You want a single-page application (SPA) with client-side routing
  • āœ… You want the full power of React and MDX
  • āœ… You do not need support for IE11
Comparison with other tools

Docusaurus v2 is beta but already quite stable and widely used.

We highly encourage you to use Docusaurus v2 over Docusaurus v1, as Docusaurus v1 will be deprecated soon.

A lot of users are already using Docusaurus v2 (trends).

Use Docusaurus v2 if:

  • āœ… You want a modern Jamstack documentation site
  • āœ… You want a single-page application (SPA) with client-side routing
  • āœ… You want the full power of React and MDX
  • āœ… You do not need support for IE11