https://github.com/greendelta/lca-collaboration-server-manual
The official manual of the LCA Collaboration Server
https://github.com/greendelta/lca-collaboration-server-manual
Last synced: 4 months ago
JSON representation
The official manual of the LCA Collaboration Server
- Host: GitHub
- URL: https://github.com/greendelta/lca-collaboration-server-manual
- Owner: GreenDelta
- Created: 2024-02-29T13:32:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-05T09:30:24.000Z (over 1 year ago)
- Last Synced: 2025-04-04T18:47:14.931Z (about 1 year ago)
- Homepage: https://greendelta.github.io/lca-collaboration-server-manual/
- Size: 4.15 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LCA Collaboration Server Manual
This is the main repository for the manual of the [LCA Collaboration Server](https://www.openlca.org/collaboration-server/).
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/lca-collaboration-server-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/lca-collaboration-server-manual/actions/workflows/mdbook.yml).
The CS 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/lca-collaboration-server-manual
mdbook build
```
In order to vizualise your change while working, use the following command:
```bash
cd PATH/TO/lca-collaboration-server-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.