mkdocs/README.md
francesco 7bf8bd8e50
All checks were successful
continuous-integration/drone/push Build is passing
add build badge
2021-10-13 01:10:53 +02:00

835 B

Build Status

Hier Entsteht ein Documentation für verschiedene 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.