Don't know how to program? Start here instead! This guide is intended for programmers.
The fastest and easiest way to contribute is to clone the repository and run the app locally.
- Ensure you have modern versions of Node and NPM installed.
- Clone the repository and run
npm startto run the development server. You should be able to see the app running on
localhost:3000. As you edit documentation, the app will self-refresh to reflect your changes.
The documentation is located in the
docs folder. Each markdown file is used to generate a single page of documentation. To set this up properly, each markdown file has a header that starts and ends with
---. There are a number of options you can specify, but the required options are
title. Take a look at the markdown file that generates this page for an example.
When you create a new page, you can add it to the navigation component by registering it in
sidebars.js. In this file each page is referred to by its path relative to the
docs folder plus the page ID. For example if you create a page with ID
/docs/researchers/news/newFeatures.md, you could refer to that page as
Note that after you add a new page you will need to restart the server to see it in the app.
First, rename your image files using the following format:
page_name_imagenumber.format. For example, the third image on the "Researcher overview page" should be named
Now all you need to do is add your images to
static/img and refer to them using the following format.
Please do not omit the alt text - it is important for accessibility and SEO.
All of this is discussed in much more depth in the Docusaurus documentation.