Toto je starší verze dokumentu!
MkDocs
Dokumentátor jsem zvolil, protože je docela jednoduchý na obsluhu a dokumentaci je možné psát v Markdownu.
Použil jsem MkDocs s rozšířením Material for MkDocs.
Instalace pomocí Dockeru:
docker pull squidfunk/mkdocs-material
Založení adresáře se základním souborem:
docker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material new .
Spuštění development prostředí:
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
Sestavení dokumentace do HTML:
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material build
Mermaid pro MkDocs
Pro kreslení grafů je potřeba přidat plugin pro Mermaid. Vycházel jsem z dokumentace.
Editoval jsem soubor mkdocs.yml a přidal plugin Mermaid:
site_name: My Documentation
markdown_extensions:
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
Pak už stačí přidat kód pro graf Mermaid.
``` mermaid
graph LR
A[Start] --> B{Error?};
B -->|Yes| C[Hmm...];
C --> D[Debug];
D --> B;
B ---->|No| E[Yay!];
```
Pro zkoušení možností grafů Mermaid lze použít i Mermaid Live editor. Užitečná může být dokumentace pro kreslení grafů v Mermaidu.
Petr Nosek