diff options
| -rw-r--r-- | mkdocs/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/mkdocs/README.md b/mkdocs/README.md new file mode 100644 index 0000000..147e71a --- /dev/null +++ b/mkdocs/README.md @@ -0,0 +1,24 @@ + +# Generate web site + +# mkdocs folder under project root +$ `cd mkdocs` + +* create a pyenv virtual environment + +$ `pip install -r requirements.txt` + +$ `./generate-web-site.sh` (static files will be generated into `./generated-site`) + +$ `git checkout gh-pages` + +$ `cd ../` # back to project root + +$ `scp -r mkdocs/generated-site/* ./` + +$ `git add` all modified files + +* commit to git + +$ `git push origin gh-pages` + |