Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1.24 KB

README.md

File metadata and controls

23 lines (15 loc) · 1.24 KB
Raw

openLCA 2 manual

This is the main repository for the manual of openLCA 2.

The manual is created using mdBook and can be browsed on its Github page: https://greendelta.github.io/openLCA2-manual/.

In order to publish your changes to the manual, make sure that the main branch is up to date and click on Run workflow on the Deploy mdBook site to Pages.

The openLCA manual is compiled from the resources in this repository using mdBook. Thus, you need to have the mdbook executable installed (one simple option is to just download the mdbook executable from the mdBook releases page and put it next to the book.toml file at the root of this project). Then you can run the build from the command line:

cd PATH/TO/openLCA2-manual
mdbook build

In order to vizualise your change while working, use the following command:

cd PATH/TO/openLCA2-manual
mdbook serve --open

See also the mdBook tutorial for more options to test the book locally.