creeperplayer20 / docs

SPSUL DOCS

Shrnutí materiálů pro obor IT - SPSUL Stříbrníky

O projekt se stará Jakub Grezl

Pokud tě něco zajímá, nebo máš nápad. Neváhej kontaktovat Jakuba na discordu: chcispat nebo vytvoř issue.

Pomož nám s dokumentací

Pokud ti něco chybí, nebo se ti něco nelíbí, neváhej a přidej to sem!

Jak psat docs? 🤔

Potřebuješ git, node.js a npm. Nebo docker (až budu mít náladu přidám docker compose)

1. Vytvoř si fork tohoto repozitáře
2. Naklonuj si tovje forknutý repo git clone https://github.com/<tvuj_username>/docs.git
3. Půjdeš do naklonované složky docs a nainstaluješ si projekt pomocí npm install
4. Dev server zapneš pomocí npm run start
5. Podívej se jak funguje MDX nebo na náš example
6. Přidej věci do složky docs, změny uvidíš na localhostu
7. Až budeš spokojenej, přidáš změny git add .
8. Commitneš svoje změny git commit -m "Něco jsem přidal 🔥🔥🔥"
9. Pushneš je do svýho github repozitáře git push
10. Vytvoříš pull request
11. Pokud nejsi uplně debil, tak ti to někdo schválí a přidá změny do hlavního repozitáře, který se deployne na docs.spsul.cz

TODO:

• Přidat search engine - Algolia nebo Meilisearch
• Přidat linky na užitečný věci (např. w3schools, sandboxy, tutorialy)
• Udělat lab
• [JS vytahy] (https://play.elevatorsaga.com/)

License

Docusaurus je licencován licencí MIT.

Dokumentace (například .md a .mdx soubory v adresáři /docs) jsou licencovány GPLv3.

Contributors ✨

Děkujeme všem lidem, kteří přispěli do tohoto projektu.

Bagros Commits

Jakub Grezl Commits

Janxyxy Commits

Jan Kubat Commits

DJ - Creeperplayer20 Commits