Blame README.md

12bb45
# CentOS Infra documentation
12bb45
12bb45
This git repository contains the needed sources (markdown format) used to generate the CentOS Infra documentation website.
12bb45
12bb45
It uses [mkdocs](https://mkdocs.org) but with a specific [material](https://squidfunk.github.io/mkdocs-material) theme
12bb45
12bb45
## How to test locally
12bb45
The easiest way is just to use podman and a container:
12bb45
12bb45
```
12bb45
podman pull docker.io/squidfunk/mkdocs-material:latest
12bb45
```
12bb45
12bb45
You can then enter the directory where you have cloned this repository (where mkdocs.yml is) and then you can run the following development site (that will automatically refresh on each new file/change) :
12bb45
12bb45
```
a06a9c
podman run --rm -it -p 8000:8000 -v ${PWD}:/docs:z squidfunk/mkdocs-material
12bb45
```
12bb45
12bb45
You can now open your browser to http://localhost:8000 and you'll be able to see `live` your edit/changes
12bb45
12bb45
## How to render/build the site as static pages
12bb45
12bb45
Still using same podman container, but instead call it like this : 
12bb45
12bb45
```
a06a9c
podman run --rm -it -v ${PWD}:/docs:z squidfunk/mkdocs-material build
12bb45
12bb45
```
12bb45
12bb45
Worth knowing that the goal is to just develop locally , and then git commit/push as the built site will automatically be rendered in the next minutes on public website