6b1a61461b
Bootstraps an MkDocs Material documentation site (rendered to
docs.makerfloss.eu by the Forgejo Actions runner). The first feature
is an auto-generated hardware overview built from per-host YAML
frontmatter blocks under docs/hardware/.
- mkdocs.yml, requirements.txt: MkDocs Material 9.5 + pyyaml
- Makefile: docs-index | docs-build | docs-serve | docs-check
- scripts/gen_overview.py: stdlib + pyyaml generator, deterministic and
offline. Reads scripts/overview_config.yml — category-driven so
services/vms can plug in later without touching the script.
- scripts/overview_config.yml: hardware schema and index layout
- docs/hardware/{makerfloss,fisi,tembo}.md: 3 sample entries
- docs/hardware/index.md: GENERATED, committed (CI fails on drift)
- docs/index.md: site landing page
- .forgejo/workflows/docs.yml: drift-check + mkdocs build --strict +
rsync site/ to /srv/docs-makerfloss/html on push to main
- .gitignore: site/, .venv, __pycache__
Schema:
- hostname, kind, status (required; kind/status are enums)
- model, location, cpu, cpu_cores, cpu_threads, ram_gb, storage_gb,
storage_type (enum), storage_notes, nic_gbps (all optional)
- Filename stem MUST equal hostname (enforced by generator)
- Extra optional fields are accepted silently and live on the per-page
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
55 lines
1.2 KiB
YAML
55 lines
1.2 KiB
YAML
site_name: MakerFLOSS Docs
|
|
site_url: https://docs.makerfloss.eu/
|
|
site_description: Documentation for the MakerFLOSS initiative at Orange Makerspace.
|
|
|
|
repo_url: https://forgejo.makerfloss.eu/sjat/MakerFLOSS
|
|
repo_name: sjat/MakerFLOSS
|
|
edit_uri: _edit/main/
|
|
|
|
theme:
|
|
name: material
|
|
features:
|
|
- navigation.indexes
|
|
- navigation.sections
|
|
- navigation.top
|
|
- content.code.copy
|
|
- search.suggest
|
|
- search.highlight
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: deep orange
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: deep orange
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- toc:
|
|
permalink: true
|
|
- tables
|
|
- attr_list
|
|
- md_in_html
|
|
- pymdownx.superfences
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
|
|
plugins:
|
|
- search
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Hardware:
|
|
- hardware/index.md
|
|
- House rules: makerFLOSS_house_rules.md
|