BMEVIAUMB11 - Skálázható szoftverek tárgy jegyzetei, labor anyagai, házi feladatai.
A jegyzetek Material for MkDocs segítségével készülnek és GitHub Pages-en kerülnek publikálásra: https://bmeaut.github.io/mkdocs-course-materials-template/
A futtatáshoz Dockerre van szükség, amihez Windows-on a Docker Desktop egy kényelmes választás.
A GitHub Codespaces funkciója jelentős mennyiségű virtuális gép időt ad a felhasználók számára, ahol GitHub repositoryk tartalmát tudjuk egy virtuális gépben fordítani és futtatni.
Ehhez elegendő a repository (akár a forkon) Code gombját lenyitni majd létrehozni egy új codespace-t. Ez lényegében egy böngészős VSCode, ami egy konténerben fut, és az alkalmazás által nyitott portokat egy port forwardinggal el is érhetjük a böngészőnkből.
A repository tartalmaz egy Dockerfile-t, mely az MKDocs keretrendszer és függőségeinek konfigurációját tartalmazza. Ezt a konténert le kell buildelni, majd futtatni, ami lebuildeli az MKDocs alapú dokumentációt, és egyben egy fejlesztési idejű webservert is elindít a dokumentáció "futtatásához".
-
Terminál nyitása a repository gyökerébe.
-
Adjuk ki ezt a parancsot Windows (PowerShell), Linux és MacOS esetén:
docker build -t mkdocs . docker run -it --rm -p 8000:8000 -v ${PWD}:/docs mkdocs -
http://localhost:8000 vagy a codespace átirányított címének megnyitása böngészőből.
-
Markdown szerkesztése és mentése után automatikusan frissül a weboldal.