Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

Visit [https://vik-ce-notes.github.io/](https://vik-ce-notes.github.io/)

The notes are based on the official lecture notes and the slides of the hungarian courses. This is a best-effort project, so errors and omissions may occur. If you find any mistakes please contact us so we can make corrections.
The notes are based on the official lecture notes and the slides of the Hungarian courses. This is a best-effort project, so errors and omissions may occur. If you find any mistakes, please contact us so we can make corrections.

#### For future contributors

If you want to help us, please start by checking out our [instructions page](https://vik-ce-notes.github.io/for_contributors/index.html)
If you want to help us, please start by checking out our [instructions page](https://vik-ce-notes.github.io/for_contributors/index.html)
18 changes: 9 additions & 9 deletions docs/for_contributors/index.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# Jegyzeteléshez

???+ info "Háttértörténet"
Szinte az összes tantárgyhoz készült jegyzet$^*$, amik egy privát GitHub repositoryba lettek feltéve. Ezek mind [markdownban](https://en.wikipedia.org/wiki/Markdown) készültek egy bizonyos flavor-rel és egész jól szerepeltek számonkérések során. A repo-nak a megosztása azonban több problémába is ütközött, ezért jött létre egy nyílt alternatíva, ami remélhetőleg több VIK-es hallgató tanulmányait is elősegítheti.
Szinte az összes tantárgyhoz készült jegyzet$^*$, amik egy privát GitHub repositoryba lettek feltéve. Ezek mind [Markdownban](https://en.wikipedia.org/wiki/Markdown) készültek egy bizonyos flavor-rel és egész jól szerepeltek számonkérések során. A repónak a megosztása azonban több problémába is ütközött, ezért jött létre egy nyílt alternatíva, ami remélhetőleg több VIK-es hallgató tanulmányait is elősegítheti.

<p style="font-size: 0.8em; font-style: italic">*: A specializációnál ezt már nehezebb volt tartani, ott a szoftverfejlesztés ágazat specifikus tárgyai lettek tárgyalva</p>
<p style="font-size: 0.8em; font-style: italic">*: A specializációnál ezt már nehezebb volt tartani, ott a szoftverfejlesztés ágazatspecifikus tárgyai lettek tárgyalva</p>

## Új jegyzet feltöltése

#### Szerkesztés
Alapvetően a Visual Studio Code-hoz készült [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) kiegészítőt használtuk jegyzetek készítésére, ezért az oldalt is igyekeztünk úgy létrehozni, hogy támogassa minden funkcióját. Ezt a [showcase](./showcase.md) odalon részletesebben is megnézheted.
Alapvetően a Visual Studio Code-hoz készült [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) kiegészítőt használtuk jegyzetek készítésére, ezért az oldalt is igyekeztünk úgy létrehozni, hogy támogassa minden funkcióját. Ezt a [showcase](./showcase.md) oldalon részletesebben is megnézheted.

Vagyis elegendő ezt a kiegészítőt használni a `docs` mappán belül, ha csak dokumentációs céljaid vannak. Természetesen azt is szeretnénk, hogy az általad készített dokumentumok elérhetőek legyenek, ezért a gyökérmappában a `mkdocs.yaml` fájlban, a `nav` tulajdonságban fel kell venned a dokumentumaid nevét és elérési módját.

#### Feltöltés
Ahhoz, hogy a dokumentumaid / javításaid megoszd másokkal az alábbi lépéseket javasoljuk:
Ahhoz, hogy a dokumentumaidat / javításaidat megoszd másokkal, az alábbi lépéseket javasoljuk:

**For contributors:**

1. Klónozd le a repository-t
```bash
git clone https://github.com/VIK-CE-Notes/vik-ce-notes.github.io
git clone [https://github.com/VIK-CE-Notes/vik-ce-notes.github.io](https://github.com/VIK-CE-Notes/vik-ce-notes.github.io)
```
2. Végezd el a változtatásokat
3. Egy új branch-en töltsd fel
Expand All @@ -40,12 +40,12 @@ Ahhoz, hogy a dokumentumaid / javításaid megoszd másokkal az alábbi lépése

## Az oldal formálása

#### Python környezet használata
Amennyiben nagyobb változtatást szeretnél eszközölni (például új diagram típus támogatása), akkor már valószínűleg szükséged lesz a python környezet használatára.
#### Python-környezet használata
Amennyiben nagyobb változtatást szeretnél eszközölni (például új diagramtípus támogatása), akkor már valószínűleg szükséged lesz a Python-környezet használatára.

A projekt [MkDocs](https://www.mkdocs.org/)-ra épül, a témája [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) és Python `3.11`-es verziót használ. Kezdetként az alábbi lépéseket tudom ajánlani:
```bash
git clone https://github.com/VIK-CE-Notes/vik-ce-notes.github.io
git clone [https://github.com/VIK-CE-Notes/vik-ce-notes.github.io](https://github.com/VIK-CE-Notes/vik-ce-notes.github.io)
cd vik-ce-notes.github.io

# itt hozhatsz létre virtuális környezetet
Expand All @@ -54,4 +54,4 @@ pip install -r requirements.txt
mkdocs serve
```

Mostmár a [http://127.0.0.1:8000](http://127.0.0.1:8000) url-en el is érheted az oldalt.
Mostmár a [http://127.0.0.1:8000](http://127.0.0.1:8000) url-en el is érheted az oldalt.
2 changes: 1 addition & 1 deletion docs/for_contributors/showcase.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Showcase

Itt láthatod, hogy hogyan jelenik meg egy Markdown fájl tartalma. *(A dokumentum a repository-ban a `doc/for_contributors/showcase.md` útvonalon érhető el.)*
Itt láthatod, hogy hogyan jelenik meg egy Markdown fájl tartalma. *(A dokumentum a repository-ban a `docs/for_contributors/showcase.md` útvonalon érhető el.)*

---

Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Kellemes informálódást!

---

??? warning A jegyzetek teljességéről
Ez egy best-effort projekt, az összes erőfeszítésünk ellenére tévedések és elírások előfordulhatnak. Amennyiben ilyennel találkozol kérlek jelezd nekünk issue-ban vagy javítsad ki az útmutató alapján.
??? warning "A jegyzetek teljességéről"
Ez egy best-effort projekt, az összes erőfeszítésünk ellenére tévedések és elírások előfordulhatnak. Amennyiben ilyennel találkozol, kérlek, jelezd nekünk issue-ban vagy javítsd ki az útmutató alapján.

Előre is köszönjük :heart:
Előre is köszönjük :heart:
Loading