Source documents and MkDocs configuration for http://htcondor-ce.org served by GitHub Pages. The documentation is built using the mkdocs-material container with a GitHub Action.
To preview the pages, start a MkDocs development server. The development server will automatically detect any content changes and make them viewable in your browser.
-
cd
into the directory containing the local clone of your GitHub fork -
Start a MkDocs development server to preview your changes:
$ docker run --rm -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:7.1.0
To preview your changes visit
localhost:8000
in the browser of your choice. The server can be stopped withCtrl-C
.
To contribute changes to the documentation, please submit a
pull request.
The reason for this is two-fold: document and link validation CI checks are run on pull requests and anything pushed to
the docs
branch is immediately published to http://htcondor-ce.org.