20 lines
835 B
Markdown
20 lines
835 B
Markdown
[![Build Status](https://drone.r4o.ch/api/badges/francesco/mkdocs/status.svg)](https://drone.r4o.ch/francesco/mkdocs)
|
|
|
|
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:
|
|
```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. |