Přispívání

Software

Pro participaci na tvorbě materiálů je třeba mít nainstalovaný GIT a jakýkoliv textový editor (ideálně VSCodium či jiný editor s podporou VS Code Extensions).

Proces publikování vytvořených materiálů zajišťuje CLI nástroj mdBook (ke stažení zde). Po rozbalení archivu je ideální přidat cestu k binárce do PATH, poté není při volání nutné udávat celou její cestu.

Nastavení prostředí

Klonování repozitáře

git clone https://codeberg.org/atlas144/szz.git

VS Code Extensions

Pokud používáte editor s podporou VS Code Extensions, doporučujeme nainstalovat tyto:

• Markdown All in One
• Code Spell Checker
• Czech - Code Spell Checker
  • je nutné upravit Předvolby > Nastavení > cSpell.language na en,cs
• Better TOML

Postup

Řekněme, že budeme zpracovávat okruh 2.1.5. Soubor instrukcí (2.1.5. je číslo kapitoly, viz seznam).

Příprava

V repozitáři vytvoříme novou větev v větve main s názvem 2-1-5-soubor-instrukci:

Poté stáhneme změny pomocí

git pull

a přesuneme se do nově vytvořené větve.

git checkout 2-1-5-soubor-instrukci

Obsah

Nyní můžeme začít upravovat soubor pro daný okruh. Zdrojové soubory se nachází ve složce ./src a následujících podsložkách podle předmětu. Zde Informační a komunikační technologie > Architektura počítačů > Soubor instrukcí, cesta tedy je ./src/ikt/ap/soubor-instrukci.md.

Přidáváme-li obrázky či jiný dodatečný obsah, vytvoříme složku s názvem okruhu (zde tedy ./src/ikt/ap/soubor-instrukci) a obsah přidáváme do ní.

V průběhu editace je užitečné vidět finální podobu dokumentu. K tomu slouží náhledy v editoru:

Rovněž si lze výslednou podobu prohlédnou přímo pomocí mdBook, a to spuštěním příkazu

mdbook serve -o             # pokud je lokace v PATH
[cesta]/mdbook serve -o     # pokud se binarka spousti primo

Změny je dobré průběžně commitovat a pushovat na server!

git commit -m "feat(content): lorem ipsum"
git push

Formát zápisu

Obsah je zapisován ve formátu Markdown s rozšířeními, která jsou popsána zde.

Pro zápis matematických výrazů lze použít MathJax (s drobnými omezeními).

Zdroje

Zdroje přidáváme nakonec souboru, v samostatné sekci. Ideální formát je citace podle normy ČSN ISO 690. Minimální formát je odkaz na web.

Konec editace

Považujeme-li okruh za dokončený, pushneme změny a následně otevřeme pull request ze zpracovávané větve (2-1-5-soubor-instrukci) do main:

Po schválení se nově zpracovaný okruh objeví na stránce.