ETM Documentation

Please update your links: documentation is now published and searchable at https://docs.energytransitionmodel.com

This repository contains the source for the ETM Docs website. It's built using Docusaurus 2; please see Installation for instructions on getting up-and-running.

Adding documentation

Please see the published documentation for details on how to add, change, and remove documents (in-repo link).

Installation

If you wish to preview the site locally, you should start by installing Yarn. Then running yarn will install the dependencies.

$ yarn

Local Development

$ yarn start

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

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Deployment happens automatically when your changes are pushed to the master branch.