https://github.com/kube-rs/website

website
https://github.com/kube-rs/website

documentation mkdocs

Last synced: about 2 months ago
JSON representation

website

• Host: GitHub
• URL: https://github.com/kube-rs/website
• Owner: kube-rs
• Created: 2022-02-06T12:08:16.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-22T10:36:40.000Z (9 months ago)
• Last Synced: 2024-04-22T11:39:04.588Z (9 months ago)
• Topics: documentation, mkdocs
• Language: Markdown
• Homepage: https://kube.rs
• Size: 1.68 MB
• Stars: 6
• Watchers: 7
• Forks: 15
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • Security: docs/security.md
  • Governance: docs/governance.md

Awesome Lists containing this project

README

        
# kube-rs website

[![release](https://github.com/kube-rs/website/actions/workflows/release.yml/badge.svg)](https://github.com/kube-rs/website/actions/workflows/release.yml)

Markdown documents and scripts for generating the [kube.rs](https://kube.rs) website.

Hosted on [github pages](https://kube-rs.github.io/website).

## Setup

This repo uses [`mkdocs`](https://www.mkdocs.org/) with [mkdocs-material](https://squidfunk.github.io/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](https://github.com/artempyanykh/marksman), or through [foam](https://foambubble.github.io/foam/) for vs code with the recommended extensions in this repo.

## Organisation

The [mkdocs.yml](./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 `` header, so try to keep an eye out for this.

For a full overview see the [sync.sh](https://github.com/kube-rs/website/blob/main/sync.sh) script.