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). Checkout some sites build with docusaurus for some inspiration. Did you know? this site is build with docusaurus too.
Let's discover Docusaurus in less than 5 minutes.
Get started by creating a new site.
Or try Docusaurus immediately with docusaurus.new.
What you'll need
- Node.js version 16.14 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
Generate a new site
Generate a new Docusaurus site using the classic template.
The classic template will automatically be added to your project after you run the command:
npm init docusaurus@latest my-website classic
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
The command also installs all necessary dependencies you need to run Docusaurus.
Start your site
Run the development server:
npm run start
cd command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
npm run start command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
docs/intro.md (this page) and edit some lines: the site reloads automatically and displays your changes.
visit Docusaurus Tutorial for detailed instruction on using docusaurus