Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.
Important Note: If you are setting up a new Docusaurus website for a Facebook Open Source project, we highly encourage you to use Docusaurus 2 instead.
We have created a helpful script that will get all of the infrastructure set up for you:
Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.
You have to be on Node >= 10.9.0 and Yarn >= 1.5.
Create a project, if none exists, and change your directory to this project's root.
You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories:
Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.
Run the Docusaurus installation script:
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
Along with previously existing files and directories, your root directory will now contain a structure similar to:
root-directory ├── Dockerfile ├── README.md ├── docker-compose.yml ├── docs │ ├── doc1.md │ ├── doc2.md │ ├── doc3.md │ ├── exampledoc4.md │ └── exampledoc5.md └── website ├── blog │ ├── 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
This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the Docker documentation.
Running the example website
After running the Docusaurus initialization script,
docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:
From within the
websitedirectory, run the local web server using
Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.
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. A randomly generated primary and secondary theme color will be picked for you.
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)
Updating Your Docusaurus Version
At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the
website directory and typing
yarn outdated docusaurus or
npm outdated docusaurus.
You will see something like this:
$ yarn outdated Using globally installed version of Yarn yarn outdated v1.5.1 warning package.json: No license field warning No license field info Color legend : "<red>" : Major Update backward-incompatible updates "<yellow>" : Minor Update backward-compatible features "<green>" : Patch Update backward-compatible bug fixes Package Current Wanted Latest Package Type URL docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/docusaurus#readme ✨ Done in 0.41s.
If there is no noticeable version output from the
outdatedcommands, then you are up-to-date.
You can update to the latest version of Docusaurus by:
yarn upgrade docusaurus --latest
npm update docusaurus
If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a temporary directory or run the Docusaurus server (e.g.,
yarn start) with the