mirror of https://github.com/Desuuuu/klipper.git
2f9fe49cb8
Add a documentation page with information on how to support Klipper. Signed-off-by: Kevin O'Connor <kevin@koconnor.net> |
||
|---|---|---|
| .. | ||
| css | ||
| README | ||
| build-translations.sh | ||
| mkdocs-requirements.txt | ||
| mkdocs.yml | ||
| mkdocs_hooks.py | ||
README
This directory defines the https://www.klipper3d.org/ website. The site is hosted using "github pages". The .github/workflows/klipper3d-deploy.yaml tool uses mkdocs ( https://www.mkdocs.org/ ) to automatically convert the markdown files in the docs/ directory to html. In addition to the files in this directory, the docs/CNAME file also controls the website generation. To test deploy the main English site locally one can use commands similar to the following: virtualenv ~/mkdocs-env && ~/python-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt cd ~/klipper && ~/mkdocs-env/bin/mkdocs serve --config-file ~/klipper/docs/_klipper3d/mkdocs.yml -a 0.0.0.0:8000 To test deploy the multi-language site locally one can use commands similar to the following: virtualenv ~/mkdocs-env && ~/python-env/bin/pip install -r ~/klipper/docs/_klipper3d/mkdocs-requirements.txt source ~/mkdocs-env/bin/activate cd ~/klipper && ./docs/_klipper3d/build-translations.sh cd ~/klipper/site/ && python3 -m http.server 8000