first commit
This commit is contained in:
commit
6ad92f944d
6 changed files with 72 additions and 0 deletions
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
@ -0,0 +1,2 @@
|
|||
.cache
|
||||
site/
|
3
Dockerfile
Normal file
3
Dockerfile
Normal file
|
@ -0,0 +1,3 @@
|
|||
FROM docker.io/squidfunk/mkdocs-material
|
||||
|
||||
RUN pip install mkdocs-glightbox
|
8
Makefile
Normal file
8
Makefile
Normal file
|
@ -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
|
17
docs/index.md
Normal file
17
docs/index.md
Normal file
|
@ -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.
|
10
docs/physical-network.md
Normal file
10
docs/physical-network.md
Normal file
|
@ -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!];
|
||||
```
|
32
mkdocs.yml
Normal file
32
mkdocs.yml
Normal file
|
@ -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
|
Loading…
Add table
Reference in a new issue