Skip to main content

Getting Started

Read the Docusaurus documentation for information on how Docusaurus works. The following sections only outline the minimum setup needed to set this template up for your own site.

Run npm install and npm run start to get started with development.

Config​

After cloning this template repo, you will need to replace all the placeholder values in the docusaurus.config.js folder. The main fields that you will definitely need to replace are commented with "set this".

Have a look at the Docusauraus configuration docs to see if there are any other additional configuration options you would need for your purpose.

Pages​

The main index page will need to be modified. This can be found at src/pages/index.js.

You can then delete all the files in the docs/ directory and start writing your own pages.

Styles​

Change the --ifm-color css variables for light and dark mode in src/css/custom.scss using the Docusaurus theme colour picker

Other Changes​

  • Change the name field in package.json to the name of your project.
  • Change the logo and favicon in the static/img directory to your own logo and favicon. If you change the names of these files, update them in docusaurus.config.js.
  • Update the name in LICENSE (or the licence if you want to use a different license)