Je eerste aanpassingen via GitHUB

14. Je eerste aanpassingen via GitHUB#

Zoals in het vorige hoofdstuk uitgelegd, je bestanden staan op GitHub en het template zorgt ervoor dat het boek gebouwd wordt. Je kunt online, in GitHub, direct wijzigingen aanbrengen aan de bestanden, en nieuwe bestanden aanmaken of uploaden.

In het template boek zijn al een aantal bestanden aanwezig. De folderstructuur zie je weergegeven in Figuur 14.1.

../_images/templatecontent.PNG

Fig. 14.1 De folderstructuur in het templateboek.#

We gaan nu aan de slag met een kleine aanpassing aan een van de bestanden om vervolgens te kijken naar het resultaat van die wijziging.

Exercise 14.1 (Je eerste aanpassing)

Navigeer naar het bestand book/some_content/overview.md. Klik dan op de pen aan de rechterkant (edit this file).

Verander de tekst na de #. Dit is de titel van het bestand.

../_images/eersteedit.gif

Breng eventueel andere wijzigingen aan in de teksteditor en als je klaar bent, commit je je wijzigingen naar de “remote repository” door op de groene Commit changes knop te klikken.

Het boek wordt nu opnieuw gebouwd. Als dat klaar is, kun je het resultaat op de GitHub page bekijken.

Samenvatting bij commit

Werk je met meerdere mensen in GitHub, of zelf aan een groot project. Dan is het verstandig om de commit een herkenbare titel (commit message) te geven en eventueel een samenvatting (extended description) toe te voegen wat er precies gewijzigd is. Zo kun je eventuele fouten vroegtijdig opsporen en te niet doen. Ook kun je uitleggen waarom bepaalde aanpassingen gedaan zijn.

14.1. Toevoegen van een figuur#

Een figuur zegt soms meer dan 1000 woorden…

Externe afbeelding

Als we een figuur in ons boek willen toevoegen, dan kunnen we verwijzen naar een andere website (zoals in bovenstaande figuur). Dat brengt wel het risico met zich mee dat deze figuur niet meer zichtbaar is als de figuur van locatie verhuist. Het is dus beter dat het figuur zich in een eigen bron bestand is.

We moeten dus eerst een figuur uploaden naar GitHub en vervolgens in onze file verwijzen naar die figuur. (Let op! Later wordt dit veel makkelijker.)

Exercise 14.2

Op GitHub, onder het kopje code…

  1. Navigeer naar book/figures en klik op add file Upload files.

../_images/incl_fig.PNG

Fig. 14.2 add bestand in de folder#

  1. Kies de figuur die je toe wilt voegen (onthoud de naam van de file!).

  2. Commit je veranderingen naar github (het bestand wordt geüpload)

  3. Navigeer naar book en open intro.md en druk op edit this file.

  4. Kopieer de code hieronder naar die file, pas de naam van het figuur aan naar de naam van je eigen figuur.

``` {figure} figures/incl_fig.PNG
---
width: 50%
name: fig_mijneerstefiguur
---
add bestand in de folder
```

  1. Commit je verandering en bekijk het resultaat op GitHub pages.

Warning

De code is hoofdletter gevoelig. Het maakt dus uit of je extensie .png is of .PNG

Tip

We hebben een pagina met alle belangrijke codes.

Nog meer informatie over de opties bij figuren vind je hier.

Je kunt figuren op verschillende plaatsen positioneren (links / midden / rechts /kantlijn), de grootte aanpassen, van een onderschrift voorzien etc. Raadpleeg bovenstaande documentatie en probeer de verschillende settings.

14.2. Je favoriete vergelijking#

Exercise 14.3 (Een vergelijking toevoegen)

Kijk eens op de Cheatsheet pagina hoe je een formule toevoegt en probeer dat eens…

14.3. En andere aanpassingen#

Exercise 14.4 (Andere aanpassingen)

Probeer eens wat andere aanpassingen te maken, bijvoorbeeld door de structuur van de pagina verder uit te werken in secties en subsecties, elk met wat tekst. Bekijk het resultaat.

Contents