From 092ed4bd44a171ba16dc087fa9e035555fdf494d Mon Sep 17 00:00:00 2001 From: Thomas Dupont Date: Thu, 18 Aug 2022 14:03:17 +0200 Subject: [PATCH] build: mkdocs dev script added --- documentation/mkdocs.yml | 3 +-- package.json | 3 +++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index 4d01e22cf..7815ff196 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -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 diff --git a/package.json b/package.json index cff82e16a..a126845bb 100644 --- a/package.json +++ b/package.json @@ -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",