Slate (Slatedocs)

Tato stránka je pouze pro čtení. Můžete si pouze prohlédnout zdrojový kód, ale ne ho měnit. Zeptejte se správce, pokud si myslíte, že něco není v pořádku.
====== Slate (Slatedocs) - dokumentace API ======

Hledal jsem vhodná nástroj na dokumentaci jednoduchého API. Nabízí se hned několik nástrojů, nicméně Slate má pro mě jednu velkou výhodu. Všechno budu mít v jednom souboru a napsané v Markdownu. Díky tomu budu moct srozumitelně nakopírovat dokumentaci do ChatGPT. 

Pro uživatele je pak možné vygenerovat dokumentaci jako HTML webovou stránku.


===== Instalace =====

Slate funguje tak, že je potřeba vytvořit prostředí, které přeloží Markdown do vizuálně hezké HTML podoby. To je bezvadné pro psaní (development) dokumentace. Pokud jsem s podobou dokumentace spokojený, tak provedu **build** a vygeneruje se mi HTML webová stránka bez Markdownu.

==== Vývojové prostředí v Dockeru ====

Zde je odkaz na kontejner v Dockeru: https://hub.docker.com/r/slatedocs/slate 

Stačí jednoduše nainstalovat.

<code bash>
docker pull slatedocs/slate
</code>


==== Spuštění  ====

Vytvořil jsem si adresář **Slate** a v něm tyto dvě složky:

<code bash>
build
source
</code>

Do složky src jsem nahrál obsah celé složky source ze [[https://github.com/slatedocs/slate|vzorové dokumentace]]. 

V Dockeru pak spustím:

<code bash>
root@zenbook:/home/nosek/software/slate# docker run --rm --name slate -p 4567:4567 -v $(pwd)/source:/srv/slate/source slatedocs/slate serve
</code>


Pak stačí načíst dokumentaci v prohlížeči na adrese: 
<code>
http://127.0.0.1:4567
</code>


==== Sestavení HTML dokumentace - build ====

K buildu stačí spustit tento příkaz v Docekeru a HTML dokumentaci najdu ve složce **build**. 
<code bash>
docker run --rm --name slate -v $(pwd)/build:/srv/slate/build -v $(pwd)/source:/srv/slate/source slatedocs/slate build
</code>



===== Zdroje =====

  * [[https://github.com/slatedocs/slate/wiki/Using-Slate-in-Docker|Použití Slate v Dockeru]]

{{youtube>LpSs2OX8iF0?}}