commit 6ad92f944d028314fe35715264e5f3addd41335f Author: Chris Cowley <1736762+chriscowley@users.noreply.github.com> Date: Thu Oct 3 14:03:46 2024 +0200 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bccd3dc --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.cache +site/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..7147a0a --- /dev/null +++ b/Dockerfile @@ -0,0 +1,3 @@ +FROM docker.io/squidfunk/mkdocs-material + +RUN pip install mkdocs-glightbox diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ac0fa56 --- /dev/null +++ b/Makefile @@ -0,0 +1,8 @@ +init: + podman run --rm -ti -v ${PWD}:/docs docker.io/squidfunk/mkdocs-material new . + +preview: + podman run --rm -ti -v ${PWD}:/docs -p 8000:8000 docker.io/squidfunk/mkdocs-material + +build: + podman run --rm -ti -v ${PWD}:/docs docker.io/squidfunk/mkdocs-material build diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/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. diff --git a/docs/physical-network.md b/docs/physical-network.md new file mode 100644 index 0000000..c071389 --- /dev/null +++ b/docs/physical-network.md @@ -0,0 +1,10 @@ +# Physical Network + +``` mermaid +graph LR + A[Start] --> B{Error?}; + B -->|Yes| C[Hmm...]; + C --> D[Debug]; + D --> B; + B ---->|No| E[Yay!]; +``` diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..2291b64 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,32 @@ +site_name: Cowley-tech homelab docs +site_url: https://docs.lab.cowley.tech +theme: + name: material + language: en + palette: + primary: blue grey +# - scheme: default +# toggle: +# icon: material/brghtness-7 +# name: Switch to dark mode +# - scheme: slate +# toggle: +# icon: material/brghtness-4 +# name: Switch to light mode + features: + - navigation.instant + - search.suggest + - search.highlight + icon: + logo: logo-monochrome +plugins: + - search + +markdown_extensions: + - footnotes + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - tables