Skip to content

kube-rs/website

Repository files navigation

kube-rs website

release

Markdown documents and scripts for generating the kube.rs website.

Hosted on github pages.

Setup

This repo uses mkdocs with mkdocs-material and wiki style markdown cross-links.

Editing

To preview the webpage install requirements in a virtualenv and run mkdocs serve.

Wiki links work locally given something like the marksman markdown language server, or through foam for vs code with the recommended extensions in this repo.

Organisation

The mkdocs.yml file's nav section dictates the structure of the webpage.

Interactions

This webpage copies certain files from resources elsewhere and the canonical versions thus live outside this repo.

Copied files are overwritten herein and should be edited at the root source due to github interaction effects.

The synchronised files are marked with <!--GENERATED FROM XXX--> header, so try to keep an eye out for this. For a full overview see the sync.sh script.