https://github.com/sysbiochalmers/human-gem-guide
Guide for Human-GEM
https://github.com/sysbiochalmers/human-gem-guide
Last synced: 3 months ago
JSON representation
Guide for Human-GEM
- Host: GitHub
- URL: https://github.com/sysbiochalmers/human-gem-guide
- Owner: SysBioChalmers
- License: mit
- Created: 2020-04-08T13:26:32.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-11-28T12:43:51.000Z (over 2 years ago)
- Last Synced: 2025-01-30T22:51:16.244Z (over 1 year ago)
- Homepage: https://sysbiochalmers.github.io/Human-GEM-guide
- Size: 6.99 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Human-GEM-guide
Guide for Human-GEM - [View the guide here](https://sysbiochalmers.github.io/Human-GEM-guide).
### Note: This is the repository hosting the Human-GEM **guide**. The Human-GEM **model** repository can be found [here](https://github.com/SysBioChalmers/Human-GEM).
### Editing the guide
**Do not directly edit any files in the top-level `docs/` directory. Such edits will be overwritten!**
Changes should ONLY be made to files in the `mkdocs/` directory. A GitHub action is set up to automatically regenerate all documents in the top-level `docs/` directory every time a commit is made to the `main` branch.
### Preview changes
To preview changes to the guide on your local machine before pushing commits to `main`, you will need to install [MkDocs](https://www.mkdocs.org/) using pip:
```
pip install mkdocs mkdocs-material
```
Preview your local version of the guide by running the `serve` command from within the `mkdocs/` directory:
```
cd mkdocs/
mkdocs serve
```
Changes made to files in the `mkdocs/` directory will automatically be updated in the local preview.