Deze cursus kan je raadplegen op https://sma-it.github.io
Vooreerst heb je Visual Studio Code nodig. Het cursus project kan je openen door rechtsboven op de groene knop 'Clone or download' te klikken. Dan kan je kiezen tussen Visual Studio en GitHub Desktop. Voor dit project is Visual Studio niet echt zinvol. (Je kan dat wel gebruiken voor de download, maar het maakt het complexer.) Wanneer je op GitHub Desktop klikt krijg je ook een optie om dat programma eerst te installeren.
Daarna heb je ook nog Ruby nodig om de site lokaal te kunnen testen. (De compilatie van de site gebeurt via Ruby). Je kan hier de windows installer downloaden. Na de installatie verschijnt er nog een console. Klik daar gewoon steeds op enter.
Als je ruby geinstalleerd hebt, kan je VS Code openen. Daarin kies je voor 'open folder', en open je de project folder in je GitHub directory. Eens open, kan je Ctrl+` typen om de geintegreerde terminal te openen. Die maakt alles veel eenvoudiger, en je kan ook powershell kiezen om het nog iets eenvoudiger te maken. (Powershell is beter in het terug oproepen van vorige commando's e.d.)
In de terminal typ je eerst
ruby --version
om zeker te zijn dat ruby nu in je path zit.
Vervolgens heb je bundler nodig:
gem install bundler
Dan moet je de nodige bundles voor de site installeren. Zorg dat je zeker in de project directory zit en typ
bundle install
bundle update
De bovenstaande stappen moet je maar een keer uitvoeren. Vanaf nu gaat het min of meer vanzelf. Je kan nu de webserver voor de site openen via:
bundle exec Jekyll serve
Alle modules staan in de folder \modules. De hoofdstukken voor elke module staan in \modules\modulenaam\_posts. Daarin moet elk bestand met een datum beginnen, wat we gebruiken om de volgorde van de hoofdstukken te bepalen.
Afbeeldingen staan in de folder \img. Daarin wordt dezelfde structuur als bij de modules gevolgd.
Als je iets aangepast hebt, dan toon VS Code links (3de icon) in het blauw het aantal aangepaste bestanden. Klik daar op en je krijgt een overzicht met al die bestanden en de optie om een commit naar GitHub uit te voeren: Je omschrijft je wijzigingen en kiest commit. Daarna in het dropdown menu Push Changes. Je zal dan je GitHub account ook aan VS Code kenbaar moeten maken en dan worden je wijzigingen naar GitHub gestuurd.
GitHub zal zelf de site terug renderen, maar dat kan wel even minuten duren. Daarom is het handiger om lokaal met ruby en bundler te werken zodat je het resultaat onmiddellijk kan zien.
Een cheatsheet voor Markdown: link
Headers worden aangegeven met een of meerdere hekjes (#), waarbij het aantal voor het niveau staat. Niveau 1 gebruik ik normaal niet, omdat dat nogal groot is.
Om de opmaak consistent te houden kunnen we de volgende regels volgen:
- Inline code, vermelding van een class, of c# reserved words schrijven we tussen backticks (```).
- Menu navigatie maken we duidelijk via pijltjes, cursief: File -> New -> Project.
- Bestandsnamen staan in het vet: Program.cs.
Daarnaast zijn er ook nog enkele HTML tags voorzien:
<div class="note oefening">
<p>Gebruik dit om een oefening te markeren.</p>
</div><div class="note protip">
<p>Een tip waarop je de aandacht wil vestigen.</p>
</div><div class="note waarschuwing">
<p>Een waarschuwing, verschijnt in het rood.</p>
</div>This course was created using the Jekyll Course template from P2PU.