O dokumentaci¶
Tato dokumentace slouží jako centrální místo pro technické návody a dokumentaci projektů.
Technologie¶
Dokumentace je vytvořena pomocí:
- MkDocs - generátor statických stránek
- Material for MkDocs - moderní téma
- Docker - kontejnerizace
Struktura¶
docs/
├── index.md # Úvodní stránka
├── about.md # O dokumentaci
└── projects/ # Projekty
├── citya/ # CITYA projekt
│ ├── local-deployment.md # Lokální nasazení
│ └── architecture.md # Architektura
└── [další projekty]/
Přispívání¶
Pro přidání nové dokumentace:
- Vytvořte nový
.mdsoubor v příslušné složce - Přidejte odkaz do
mkdocs.ymlv sekcinav - Rebuild dokumentace:
docker compose up -d --build
Kontakt¶
- GitHub: github.com/mberanek