phsmoura / centos / sig-guide

Forked from centos/sig-guide 2 years ago
Clone

Blame README.md

80c633
# CentOS SIG Guid documentation
80c633
80c633
This git repository contains the needed sources (markdown format) used to generate the CentOS SIG Guide website.
80c633
80c633
It uses [mkdocs](https://mkdocs.org) but with a specific [material](https://squidfunk.github.io/mkdocs-material) theme
80c633
80c633
## How to test locally
80c633
The easiest way is just to use podman and a container:
80c633
80c633
```
80c633
podman pull docker.io/squidfunk/mkdocs-material:latest
80c633
```
80c633
80c633
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) :
80c633
80c633
```
80c633
podman run --rm -it -p 8000:8000 -v ${PWD}:/docs:z squidfunk/mkdocs-material
80c633
```
80c633
80c633
You can now open your browser to http://localhost:8000 and you'll be able to see `live` your edit/changes
80c633
80c633
## How to render/build the site as static pages
80c633
80c633
Still using same podman container, but instead call it like this : 
80c633
80c633
```
80c633
podman run --rm -it -v ${PWD}:/docs:z squidfunk/mkdocs-material build
80c633
80c633
```
80c633
80c633
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