From dc3f3faa78ff37fc0f949b92a1759894fa122e72 Mon Sep 17 00:00:00 2001 From: Tyler Perkins Date: Sat, 2 Nov 2024 19:27:58 -0400 Subject: [PATCH] Add docs and rearrange images --- README.md | 6 ++--- {img => docs/img}/drives.jpg | Bin {img => docs/img}/rack.jpg | Bin {img => docs/img}/switch.jpg | Bin docs/index.md | 7 ++++++ mkdocs.yaml | 46 +++++++++++++++++++++++++++++++++++ 6 files changed, 56 insertions(+), 3 deletions(-) rename {img => docs/img}/drives.jpg (100%) rename {img => docs/img}/rack.jpg (100%) rename {img => docs/img}/switch.jpg (100%) create mode 100644 docs/index.md create mode 100644 mkdocs.yaml diff --git a/README.md b/README.md index e8a7fdd..ccab23c 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,9 @@ A [ArgoCD](https://argo-cd.readthedocs.io/en/stable/) repo describing my current - Dedicated 1500W ciruit breaker - 1100VA UPS -![server rack](./img/rack.jpg) -![network switch](./img/switch.jpg) -![zfs pool](./img/drives.jpg) +![server rack](./docs/img/rack.jpg) +![network switch](./docs/img/switch.jpg) +![zfs pool](./docs/img/drives.jpg) ## Software diff --git a/img/drives.jpg b/docs/img/drives.jpg similarity index 100% rename from img/drives.jpg rename to docs/img/drives.jpg diff --git a/img/rack.jpg b/docs/img/rack.jpg similarity index 100% rename from img/rack.jpg rename to docs/img/rack.jpg diff --git a/img/switch.jpg b/docs/img/switch.jpg similarity index 100% rename from img/switch.jpg rename to docs/img/switch.jpg diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..35da32c --- /dev/null +++ b/docs/index.md @@ -0,0 +1,7 @@ +# Gluttony Cluster + +Welcome to the documentation for my k3s cluster, aka my datacenter at home. + +## About this project + +This project is a diff --git a/mkdocs.yaml b/mkdocs.yaml new file mode 100644 index 0000000..49f3eb9 --- /dev/null +++ b/mkdocs.yaml @@ -0,0 +1,46 @@ +site_name: Gluttony-Cluster +site_url: https://docs.clortox.com/cluster +site_description: Documentation on maintaining a datacenter at home +docs_dir: docs/ +repo_name: Gitea +repo_url: https://git.clortox.com/Infrastructure/Gluttony-Cluster + +theme: + name: material + #custom_dir: docs/overrides + language: "en" + #logo: imgs/logo-white.svg + features: + - navigation.tabs + - navigation.tabs.sticky + - navigation.sections + - navigation.footer + - content.action.edit + - content.tabs.link + - content.code.annotate + - content.code.copy + +markdown_extensions: + - pymdownx.highlight + #- pymdownx.superfences: + # custom_fences: + # - name: mermaid + # class: mermaid + # format: !!python/name:pymdownx.superfences.fence_code_format + - admonition + - footnotes + - def_list + #- attr_list + #- pymdownx.tabbed: + # alternate_style: true + #- pymdownx.details + #- pymdownx.emoji: + # emoji_index: !!python/name:materialx.emoji.twemoji + # emoji_generator: !!python/name:materialx.emoji.to_svg + +extra: + generator: false + version: + method: mike + provider: mike + default: latest