🚀 Tento projekt slouží ke spolupráci mezi žáky 4ITA ve společné cestě za 🙉maturitou🙉.
Vygenerovanou stránku si můžete prohlédnout zde.
Kniha se generuje ze souborů ve formátu Markdown. Tutoriál na práci s ním naleznete zde.
Tento repozitář obsahuje nakonfigurované nástroje, které usnadňují práci s formátováním jak textu, tak i názvů commitů.
Pokud tyto nástroje chcete použít, je nutné mít nainstalovaný Node 16. Poté už jen ve složce projektu spustíte:
# nainstaluje/aktualizuje moduly
$ npm install
# nastaví hooky
$ npm run prepare
Kvůli orientaci v git historii vznikla specifikace pro názvy commitů. Podle ní by všechny commity měly mít v názvu předponu s typem úkonu, který vykonáváme.
✔️ typ: zprava
👑 typ(nazev-kapitoly): zprava
❌ toto je zmena kterou jsem udelal o volne hodine
✔️ feat: pridano rozrazeni typu monitoru # feat = něco nového (feature)
✔️ fix: zmena nazvu souboru # oprava/úprava
✔️ fix: upraveny uvod grafickych karet
👑 fix(graficke-karty): upraveny uvod
Pro více informací můžete navštívit i tuto ukázku
Slouží k formátování kódu. Spouští se při každém uložení souboru.
Hooky automaticky kontrolují soubory před tím, než je commitnete. Slouží k odchycení 🐛.
Tento krok není nutný, protože se stránka s maturitními otázkami aktualizuje sama při každém pushnutí.
Před instalací knihovny mdbook je nutné mít nainstalovaný Rust, více informací zde.
# install dependencies
$ cargo install mdbook
# build
$ mdbook build