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 set up for you:
You have to be on Node >= 8.x and Yarn >= 1.5.
Go into the root of your GitHub repo directory where you will be creating the docs.
If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run
yarn global add docusaurus-initor
npm install --global docusaurus-init. After that, run
After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the
website directory and typing
yarn outdated docusaurus or
npm outdated docusaurus. You can update to the latest version of Docusaurus by typing
yarn upgrade docusaurus --latest or
npm update docusaurus.
Along with previously existing files and directories, your root directory will now contain a structure similar to:
root-directory ├── 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 │ ├── 2017-09-25-testing-rss.md │ ├── 2017-09-26-adding-rss.md │ └── 2017-10-24-new-version-1.0.0.md ├── core │ └── Footer.js ├── package.json ├── pages ├── sidebars.json ├── siteConfig.js └── static
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. There's also a LiveReload server running and any changes made to the docs and files in the
websitedirectory will cause the page to refresh.
Launching the server behind a proxy
If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the
NO_PROXY environment variable.
SET NO_PROXY=localhost yarn start (or npm run start)