About this repo

Documentation for the MolDescriptor website (GitHub-repo)

Getting Started

This project was built using Docusaurus. Read more about the installation process here.

Requirements

• Node.js version 18.0 or above:
  • When installing Node.js, you are recommended to check all checkboxes related to dependencies.
• npm

Build

To build the website use

npm run build

This command generates static content into the build directory.

Testing your build locally

To test your build locally, run the following command:

npm run serve

You can also serve the website with live reload by running:

npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

By default, this will load your site at http://localhost:3000/.

Adding a new page

This project only uses documentation pages. To add a new page, create a new markdown file in the docs directory. The file should have a .md extension.

Read Docs Introduction for more information on how to create documentation pages.

Deployment

This project is set up to deploy to GitHub Pages using GitHub Actions. All changes to the main branch will trigger the GitHub Actions to build and deploy the website.