mkdocs/README.md

716 B

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:

sudo docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

If you want to preview the page, just run:

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.