VIAUAD02/laborok

BMEVIAUAD02 Mobil és webes szoftverek című tárgy laborfeladatai

Mobil- és Webes szoftverek - Laborok

BMEVIAUAD02 - Mobil- és Webes Szoftverek tárgy laborfeladatai.

A jegyzetek MkDocs segítségével készülnek és GitHub Pages-en kerülnek publikálásra: https://VIAUAD02.github.io/laborok/

Az MKDocs használatához a hovatalos dokumentáció segítségedre lehet.

MKDocs tesztelése (Docker-rel)

Helyi gépen

A futtatáshoz Dockerre van szükség, amihez Windows-on a Docker Desktop egy kényelmes választás.

GitHub Codespaces fejlesztőkörnyezetben

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.

Dockerfile elindítása (Helyi gépen van Codespaces-ben)

A repository tartalmaz egy Dockerfile-t, ami at 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 doksinkat, és egyben egy fejlesztési idejű webservert is elindít.

1. Terminál nyitása a repository gyökerébe.

2. 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

3. http://localhost:8000 vagy a codespace átirányított címének megnyitása böngészőből.

4. Markdown szerkesztése és mentése után automatikusan frissül a weboldal.