Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/msupply-foundation/conforma-docs
https://github.com/msupply-foundation/conforma-docs
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/msupply-foundation/conforma-docs
- Owner: msupply-foundation
- License: agpl-3.0
- Created: 2021-11-23T01:55:23.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-09T02:35:52.000Z (8 months ago)
- Last Synced: 2024-05-09T03:34:12.331Z (8 months ago)
- Language: SCSS
- Size: 63.3 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
.# Open mSupply Documentation
This repo contains the public documentation for Conforma, hosted on [https://docs.conforma.nz](https://docs.conforma.nz/docs/introduction/).
Documentation is stored in markdown files and built using [zola](https://www.getzola.org/documentation/getting-started/installation/)
## Getting Started
To edit the docs, first clone this repo locally. Then install zola: https://www.getzola.org/documentation/getting-started/installation/
You should be able to run the docs locally now, by opening a terminal or command prompt, navigating to the directory you've cloned into and entering
```
zola serve
```
The docs will then be available to view locally on http://localhost:1111
If you encounter an error:
```
Error: Failed to render section '/msupply_docs/content/_index.md'
Reason: Failed to render 'index.html': error while rendering macro `macros_header::header` (error happened in a parent template)
Reason: Variable `config.default_language` not found in context while rendering 'macros/header.html'
```
ensure that you are running a recent version of zola.
`zola 0.17.2` is known to work but there is a problem with `v0.14.0`, to check your version with run `zola --version` from terminal or a command prompt.
## Contributing
Create a branch and create a pull request for review. Pushing directly to main is blocked!
If you wish to serve images from a subdirectory rather than co-locating the content or storing in the static folder, you have to include an index file (`_index.md`) for the subdirectory to be included in the build.
## Deployment
This repo is automatically deployed to github pages on push to main. The github action is defined in `.github/workflows/static_deploy.yml`
The deployment code uses `shalzz/[email protected]`. Don't use master unless you want to fix the backwards incompatible changes that zola has added since.