Skip to content

A tudasbázisról

Ez a dokumentum különböző tananyagokat biztosít amiket meg kellett tanulnom.

Motiváció

Azért kezdtem el ezt a projektet, mert azt vettem észre, hogy amikor kidolgozok ilyen formában különböző témaköröket, akkor sokkal jobban megmaradnak a fejemben az információk. Ezen felül úgy gondolom, hogy másoknak is hasznos lehet.

Észrevételek és kérések

Amennyiben észrevételed vagy kérésed van, akkor kérlek hozz létre egy issue-t a GitHub-on.

Hozzájárulási útmutató

Amennyiben szeretnél hozzájárulni a dokumentum fejlesztéséhez, a következő módon teheted meg:

Telepítés

  1. Legyen telepítve Python
  2. Klónozd a repót: git clone https://github.com/shie1/asztali-alk-fejlesztes-docs.git
  3. Menj bele a mappába: cd asztali-alk-fejlesztes-docs
  4. Telepítsd a szükséges csomagokat: pip install -r requirements.txt
  5. Indítsd el a szervert: python -m mkdocs serve

A szerver elindítása után a dokumentum elérhető lesz a következő címen: http://127.0.0.1:8000

Mappaszerkezet

A különböző dokumentumokat a docs mappában találod. A mappán belüli .md kiterjesztésű fájlok és a mappák ahogyan elhelyezkednek tükrözve lesz az oldal bal oldali navigációs paneljében.

Dokumentumok megfelelő elnevezése

Egy új mappa első dokumentuma mindig index.md legyen. Az azt követő fájloknál pedig a sorba rendezéshez segít a számozás, a következő példa szerint:

  • index.md - legfelső dokumentum
  • 01_masodik.md - második dokumentum
  • 02_harmadik.md - harmadik dokumentum

Képek és más statikus fájlok hozzáadása

A képeket és más statikus fájlokat mindig abban a mappában kell elhelyezni ahonnan hivatkozni fogunk rá és azon belül egy assets mappában. Erre gyakorlati példákat is találsz.

  • Statikus képek: docs/01 - Programozás módszertan/04_algoritmusleiras.md fájl hivatkozik a docs/01 - Programozás módszertan/assets/ SVG képefájljaira.
  • Statikus PDF fájlok: docs/01 - Programozás módszertan/index.md fájl hivatkozik a docs/01 - Programozás módszertan/assets/ PDF fájljaira.

Üzemeltető

Sonkoly Bence