build: mkdocs dev script added

This commit is contained in:
Thomas Dupont 2022-08-18 14:03:17 +02:00 committed by Joachim Van Herwegen
parent ee38b99376
commit 092ed4bd44
2 changed files with 4 additions and 2 deletions

View File

@ -102,5 +102,4 @@ nav:
- API: ./docs/" target="_blank
# To write documentation locally, execute the next line and browse to http://localhost:8000
# docker run --rm -it -p 8000:8000 -v ${PWD}/documentation:/docs squidfunk/mkdocs-material
# Alternatively, install `mkdocs` and `mkdocs-material` using `pip`, browse to the documentation folder and run `mkdocs serve`
# npm run mkdocs

View File

@ -45,6 +45,9 @@
"build": "npm run build:ts && npm run build:components",
"build:components": "componentsjs-generator -s src -c dist/components -r css -i .componentsignore",
"build:ts": "tsc",
"mkdocs": "npm run mkdocs:docker || npm run mkdocs:pip",
"mkdocs:docker": "docker run --rm -it -p 8000:8000 -v ${PWD}/documentation:/docs squidfunk/mkdocs-material",
"mkdocs:pip": "pip install mkdocs mkdocs-material && cd documentation && mkdocs serve",
"docker": "npm run docker:setup && npm run docker:start",
"docker:clean": "./test/docker/docker-clean.sh",
"docker:setup": "./test/docker/docker-setup.sh",