Structured Homelab Documentation – Logseq & GitHub compatible (DE / EN)
Hi everyone,
I’d like to share a personal project that may be interesting for Logseq users who combine personal knowledge management with technical documentation.
I’ve published a structured homelab documentation that is designed to work cleanly with both Logseq and GitHub.
Logseq Compatibility
The documentation is fully compatible with Logseq:
-
Markdown-based, no custom extensions
-
Explicit frontmatter where required (e.g.
logseq: false) -
Folder-based structure, no implicit graph assumptions
-
Works as a file-backed knowledge base, not a wiki
-
Can be opened directly as a Logseq graph
The documentation is intentionally written to remain readable and usable outside of Logseq as well.
GitHub Compatibility
At the same time, the repository is GitHub-first:
-
Clean directory structure
-
Stable relative links
-
Clear commit history
-
Tagged releases
-
Public, readable without any Logseq-specific context
This allows using GitHub as:
-
versioned documentation store
-
public reference
-
long-term archive
Language Structure
The repository contains two fully separated documentation trees:
-
pages/– German (original) -
pages-en/– English (complete translation)
Both follow the same structure and conventions.
Homelab Scope (high level)
The documentation covers:
-
overall architecture and design principles
-
Proxmox-based virtualization
-
Docker-based services
-
networking, DNS, TLS, and reverse proxy concepts
-
NetBox as a source of truth
-
backup, restore, and recovery procedures
-
operational policies and drills
It is not a beginner tutorial, but a structured technical reference and decision log.
Why Logseq?
Logseq works very well for this kind of documentation because it:
-
does not force a proprietary format
-
respects plain Markdown
-
allows gradual enrichment without locking content in
-
supports long-term maintainability
That combination was a key design goal.
Repository
The project is public and versioned:
-
GitHub release: v1.1 – English documentation added
-
Clear separation between content, structure, and tooling
Feedback is welcome, especially from people using Logseq for technical or infrastructure documentation.