37 lines
705 B
Markdown
37 lines
705 B
Markdown
# Comfy Recipes
|
|
|
|
Comfy Recipes is a simple application that renders your recipes into HTML.
|
|
|
|
Documentation is available at <https://comfy.city/comfy-recipes/docs>
|
|
|
|
## Building the python package
|
|
Make sure you have hatchling and build modules installed.
|
|
```sh
|
|
python3 -m build
|
|
```
|
|
|
|
The package can now be installed with
|
|
```sh
|
|
pip install dist/comfy-recipes-*-py3-none-any.whl
|
|
```
|
|
|
|
## Building the docker container
|
|
```sh
|
|
docker buildx build -t git.comfy.city/Emi/comfy-recipes:local .
|
|
```
|
|
|
|
The container can now be ran
|
|
```sh
|
|
docker run --rm git.comfy.city/Emi/comfy-recipes:local
|
|
```
|
|
|
|
## Building the documentation
|
|
```sh
|
|
cd docs
|
|
mdbook build
|
|
```
|
|
|
|
Documentation can now be served with
|
|
```sh
|
|
mdbook serve
|
|
```
|