Welcome to the IKIM cluster documentation! If you are interested in the documentation, please refer to the website: https://ikim-essen.github.io/ClusterDocs/
main
are automatically built and deployed to the gh-pages
branchYou are welcome to open a pull request for changes to the documentation. If you want to make larger changes and you would like to see how they would appear on the rendered site, you can run mkdocs locally.
# Install dependencies
conda create -n cluster-docs -c conda-forge python=3.8 mkdocs mkdocs-material
conda activate cluster-docs
# Build and serve documentation
mkdocs serve
You can run markdownlint and fix basic errors as follows:
npm install -g markdownlint-cli
markdownlint docs/
markdownlint --fix docs/