https://github.com/greendelta/openlca2-manual

The official manual of openLCA 2.
https://github.com/greendelta/openlca2-manual

Last synced: 7 days ago
JSON representation

The official manual of openLCA 2.

• Host: GitHub
• URL: https://github.com/greendelta/openlca2-manual
• Owner: GreenDelta
• Created: 2024-02-21T16:43:41.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-12-16T11:59:20.000Z (9 days ago)
• Last Synced: 2024-12-16T12:38:45.176Z (9 days ago)
• Language: JavaScript
• Homepage: https://greendelta.github.io/openLCA2-manual/introduction/index.html
• Size: 54.8 MB
• Stars: 3
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# openLCA 2 manual

This is the main repository for the manual of [openLCA 2](https://www.openlca.org/).

The manual is created using [mdBook](https://rust-lang.github.io/mdBook/index.html) 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](https://github.com/GreenDelta/openLCA2-manual/actions/workflows/mdbook.yml).

The openLCA manual is compiled from the resources in this repository using [mdBook](https://github.com/rust-lang/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](https://github.com/rust-lang/mdBook/releases) 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:

```bash

cd PATH/TO/openLCA2-manual

mdbook build

```

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

```bash

cd PATH/TO/openLCA2-manual

mdbook serve --open

```

See also the [mdBook tutorial](https://rust-lang.github.io/mdBook/index.html) for more options to test the book locally.