diff --git a/README.md b/README.md index fde51d0..988092f 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -Hier Entsteht ein Documentation für ferschiedene Bereiche der Entwicklung und Netzwerk. \ No newline at end of file +Hier Entsteht ein Documentation für ferschiedene Bereiche der Entwicklung und Netzwerk. + +# Usage + +## Development +To Ensure that the page are desplayed correctly, runn the Docker container on localhost like this: +```bash +sudo docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material +``` + +If you want to preview the page, just run: +```bash +sudo docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build +``` +This will create a directory in your project called `site`. For publushing the files inside this build folder, will be coppied in the standard nginx web directory `/usr/share/nginx/html`. + +## Publish the site +The page will be deployed automatically with a push on the master branch. \ No newline at end of file