centos-sig-cloud / documentation

Created a year ago
Maintained by amoralej
Project for CloudSIG documentation under sigs.centos.org
Members 3
jcapitao1 committed a month ago

Cloud SIG documentation

This git repository contains the source files required to generate the Cloud SIG documentation hosted at: https://sigs.centos.org/cloud/

The source files are in markdown format. The repository uses mkdocs but with a specific material theme.

Testing locally

  1. Use podman and a container to test locally:
podman pull docker.io/squidfunk/mkdocs-material:latest
  1. Enter the directory where you cloned this repository (where mkdocs.yml is located) and run the following development site, which automatically refreshes with each new file or change:
podman run --rm -it -p 8000:8000 -v ${PWD}:/docs:z squidfunk/mkdocs-material
  1. Open a browser and navigate to http://localhost:8000 to see your updates.

Building the site as static pages

  1. Using same podman container, run the following command:
podman run --rm -it -v ${PWD}:/docs:z squidfunk/mkdocs-material build
  1. After you develop the content locally, git commit and push the changes. Within a few minutes, the built site will be rendered automatically on the public website.