diff options
Diffstat (limited to 'docs/_klipper3d/README')
| -rw-r--r-- | docs/_klipper3d/README | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/_klipper3d/README b/docs/_klipper3d/README index 3f291c88..b3fec47a 100644 --- a/docs/_klipper3d/README +++ b/docs/_klipper3d/README @@ -4,3 +4,17 @@ site is hosted using "github pages". The 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 |