klipper/docs/_klipper3d
Kevin O'Connor 91cba8a17f mkdocs-requirements: Update to Jinja 3.1.6
A security vulnerability was found in Jinja 3.1.5 .  The software is
not impacted by this vulnerability, but there is no harm in updating
to the fixed version.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2025-04-03 13:47:00 -04:00
..
css _klipper3d: Add comments to files in this directory 2021-07-27 13:49:06 -04:00
build-translations.sh mkdocs: Replace TOC in Translations 2022-06-03 19:14:13 -04:00
mkdocs-requirements.txt mkdocs-requirements: Update to Jinja 3.1.6 2025-04-03 13:47:00 -04:00
mkdocs.yml load_cell: Load cell gram scale () 2025-03-20 19:53:44 -04:00
mkdocs_hooks.py mkdocs_hooks: Improve check for not in a list 2021-08-02 16:14:54 -04:00
README docs: Fix typo in docs generation documentation 2025-04-01 21:13:46 -04:00

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 && ~/mkdocs-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 && ~/mkdocs-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