From 897d2670445f13cfad21c89a049948281c346c94 Mon Sep 17 00:00:00 2001 From: FlyinPancake Date: Tue, 13 Sep 2022 16:53:14 +0200 Subject: [PATCH] docs: :memo: added editor setup --- .vscode/extensions.json | 8 ++++++++ CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++-- 2 files changed, 45 insertions(+), 2 deletions(-) create mode 100644 .vscode/extensions.json diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..12d71b6 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,8 @@ +{ + "recommendations": [ + "davidanson.vscode-markdownlint", + "yzhang.markdown-all-in-one", + "usernamehw.errorlens", + "esbenp.prettier-vscode" + ] +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b5a9ad9..3daa5d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,14 +35,49 @@ Amennyiben a hozzájárulásod meg tudod valósítani indíts pull requestet Ezek a stílusok a tárgyban ajánlott editorokban könnyen beállíthatóak. - +### VSCode + +Ajánlott extensionök: + +- [`yzhang.markdown-all-in-one`](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one): MD szinkronizált live preview +- [`DavidAnson.vscode-markdownlint`](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint): MD formázás, szabályok stb. +- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode): HTML+CSS formázó +- [Error Lens](https://marketplace.visualstudio.com/items?itemName=usernamehw.errorlens): Kiemeli a hibákat hogy gyorsabben megtaláljuk őket + +Az editor beállításához nyisd meg a repo-t a gyökerében VSCode-al. A VSCode fel fogja ajánlani a két markdown extension-t. + +Ha ez megtörtént, nyiss meg egy markdown dokumentumot, lés használd a CTRL+SHIFT+P shortcutot, a command palette megnyitásához. +> A command palette a VSCode parancsaihoz nyújt hozzáférést, autocompleteeli a parancsokat és egy minimális GUI-t is biztosít. + +A command palette-be keressük meg a `Format Document With...` menüpontot és válasszuk ki. +Ekkor egy almenübe dob az editor és kiválaszthatjuk hogy melyik formázóval formázzuk a MD dokumentumokat. +Legalul lesz egy `Configure Default Formatter`, válasszuk ezt. +Ezután válasszuk a `markdownlint` extensiont, és készen vagyunk. +> **FONTOS!** +> Ne válaszd ki a prettiert formatterként, mert eltöri a szövegbuborékokat. + +Ezen felül érdemes lehet bekapcsolni a mentés előtti formázást. + +A CTRL+, shortcuttal megnyitjuk a beállításokat, és rákeresünk arra, hogy format on save. +Itt kipipáljuk a checkboxot és készen vagyunk. + +Ha ehhez nem lenne törelmed, itt a json amit a `settings.json`-ba illesztve beállítódik minden. + +```json +{ + "[markdown]": { + "editor.defaultFormatter": "DavidAnson.vscode-markdownlint", + "editor.formatOnSave": true + } +} +``` ## Ajánlások ### Android - Az androidos Kotlin és XML fileokat illetve kódrészleteket Android Studioban formázva érdemes hozzáadni az anyaghoz -- Ahhoz hogy biztosan formázva legyenek a fileok használd a `ctrl+alt+L` shortcutot +- Ahhoz hogy biztosan formázva legyenek a fileok használd a `ctrl+alt+L` shortcutot ### Markdown Fileok