Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:
While we recommend Node 8.x or greater, your Node version must at least 6.x.
Go into the root of your GitHub repo directory where you will be creating the docs.
yarn global add docusaurus-initor
npm install --global docusaurus-init
After docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the
websitedirectory and typing
npm list docusaurus. You can update to the latest version of Docusaurus by typing
Along with previously existing files and directories, your root directory will now contain a structure similar to:
root-of-repo ├── docs-examples-from-docusaurus │ └── doc1.md │ └── doc2.md │ └── doc3.md │ └── exampledoc4.md │ └── exampledoc5.md └── website │ └── blog-examples-from-docusaurus │ └── 2016-03-11-blog-post.md │ └── 2017-04-10-blog-post-two.md │ └── core │ └── Footer.js │ └── node_modules │ └── package.json │ └── pages │ └── sidebars.json │ └── siteConfig.js │ └── static
If you do not want to install the init script globally, you can install it locally and then run it via
npx docusaurus-initor from the
node_modulesdirectory that is created via
./node_modules/.bin/docusaurus-init. You may want to remove the created
node_modulesdirectory after you run the script.
Running the Docusaurus initialization script,
docusaurus-init, produces a runnable, example website to base your site upon.
- In your root, rename
- Run the local webserver via
- Load the example site at http://localhost:3000. You should see the example site loaded in your web browser.