12.2 Github pages

🔍 https://bookdown.org/yihui/bookdown/github.html 🔍 https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

Als Vorbereitung für die Veröffentlichung als eigenständige github pages müssen wir einige Anpassungen treffen. Die Dateien beim Rendering des Buches (alle .html Dateien) müssen in den Ordner docs verschoben werden. Dazu ergänzt man in der _bookdown.yml Datei den Befehl ergänzen:

Einstellungen in welchem Ordner das Book veröffentlicht werden soll

Figure 12.2: Einstellungen in welchem Ordner das Book veröffentlicht werden soll

Als nächstes erstellen wir eine .nojekyll Datei und verschieben diese nach dem rendering des books in den docs Ordner. Dazu in der Konsole file.create(".nojekyll") eingeben.

Unsere Dokumentation mit bookdown besteht aus vielen .html Dateien und kann daher über das feature github pages als eigenständige website veröffentlicht werden. Dazu müssen wir in unserem repository folgendes tun:

Settings –> Pages –> Im drop down Menü main und als Ordner /docs wählen –> save

Einstellungen für GitHub Pages

Figure 12.3: Einstellungen für GitHub Pages

Falls sich github pages nicht aktualisiert kann es daran liegen, dass die index.html Datei aktualisiert werden muss (bei GitHub website zu finden). Das sollte das Problem beheben.

Note: It can take up to 20 minutes for changes to your site to publish after you push the changes to GitHub. If your don’t see your changes reflected in your browser after an hour, see “About Jekyll build errors for GitHub Pages sites.”