feat: adding base mkdocs configuration (#366)

Signed-off-by: Michael Fornaro <[email protected]>

.github/workflows/docs.yaml

@@ -0,0 +1,24 @@
+name: docs
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - '.github/workflows/docs.yaml'
+      - 'mkdocs.yml'
+      - 'docs/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v2
+
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CONFIG_FILE: mkdocs.yml

docs/README.md

@@ -15,6 +15,7 @@
   <a href="https://github.com/pre-commit/pre-commit" alt="pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white" /></a>
 </div>
 
+
 # Overview
 
 This *repo* is a declarative implementation of a Kubernetes cluster. It's setup to use the [GitOps Toolkit](https://toolkit.fluxcd.io/get-started/) also known as Fluxv2.

docs/_static/custom.css

@@ -0,0 +1,97 @@
+@import url("https://fonts.googleapis.com/css?family=Source+Sans+Pro&display=swap");
+
+body {
+  font-family: "SourceSansPro", sans-serif;
+}
+
+.md-logo {
+    width: 40px;
+    height: 40px;
+    padding-bottom: 2px;
+    padding-top: 2px;
+}
+.md-logo img {
+    width: 40px;
+    height: 40px;
+}
+
+.md-header, .md-footer-nav {
+    background-image: linear-gradient(45deg, #B284BE 0%, #9A6DBE 24%, #775BBE 53%, #734eac 78%, #66419e 100%);
+}
+
+.md-header-nav__title {
+    font-size: .85rem;
+}
+
+.check-bullet {
+  color:#07bfa5;
+  background-color: white;
+  margin-left:-22px;
+}
+
+/* Progress bar styling */
+
+.progress-label {
+    position: absolute;
+    text-align: center;
+    font-weight: 700;
+    width: 100%;
+    /* remove original styling for thin styling
+    margin: 0 ! important; */
+    margin-top: -0.4rem ! important;
+    line-height: 1.2rem;
+    white-space: nowrap;
+    overflow: hidden;
+  }
+
+  .progress-bar {
+    /*remove original styling for thin styling
+    height: 1.2rem; */
+    height: 0.4rem;
+    float: left;
+    background: repeating-linear-gradient(
+        45deg,
+        rgba(255, 255, 255, 0.2),
+        rgba(255, 255, 255, 0.2) 10px,
+        rgba(255, 255, 255, 0.3) 10px,
+        rgba(255, 255, 255, 0.3) 20px
+      ) #2979ff;
+      border-radius: 2px;
+  }
+
+  .progress {
+    display: block;
+    width: 100%;
+    /* remove original styling for thin styling
+    margin: 0.5rem 0;
+    height: 1.2rem; */
+    margin-top: 0.9rem;
+    height: 0.4rem;
+    background-color: #eeeeee;
+    position: relative;
+    border-radius: 2px;
+  }
+
+  .progress-100plus .progress-bar {
+    background-color: #00c853;
+  }
+
+  .progress-80plus .progress-bar {
+    background-color: #64dd17;
+  }
+
+  .progress-60plus .progress-bar {
+    background-color: #fbc02d;
+  }
+
+  .progress-40plus .progress-bar {
+    background-color: #ff9100;
+  }
+
+  .progress-20plus .progress-bar {
+    background-color: #ff5252;
+  }
+
+  .progress-0plus .progress-bar {
+    background-color: #ff1744;
+  }

docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

mkdocs.yml

@@ -0,0 +1,56 @@
+# Project information
+site_name: xUnholy | Raspbernetes
+site_description: Personal home-lab or for home infrastructure in a declaritive state.
+site_author: Michael Fornaro
+site_url: https://xunholy.github.io/k8s-gitops/
+
+# Repository
+repo_name: xunholy/k8s-gitops
+repo_url: https://github.com/xunholy/k8s-gitops
+edit_uri: 'edit/main/docs/'
+
+# Configuration
+theme:
+  name: material
+  logo: https://raspbernetes.github.io/img/logo.svg
+  language: en
+  palette:
+    scheme: preference
+    primary: deep purple
+    accent: indigo
+
+docs_dir: docs/
+
+# Customization
+extra:
+  version:
+    provider: mike
+
+extra_css:
+  - _static/custom.css
+
+plugins:
+  - search
+
+markdown_extensions:
+  - admonition
+  - meta
+  - codehilite:
+      guess_lang: false
+  - toc:
+      permalink: true
+  - pymdownx.superfences:
+      highlight_code: true
+  - pymdownx.tabbed
+  - pymdownx.tilde
+  - pymdownx.progressbar
+  - pymdownx.tasklist
+  - pymdownx.superfences
+  - pymdownx.snippets
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+
+nav:
+  - Introduction: index.md
+  - Getting Started: tooling/getting-started.md