Github-pages

gh-pages

gh-pages ist ein Node.js-Paket, das als einfaches Tool dient, um statische Webseiten auf GitHub Pages zu veröffentlichen. Es ist besonders nützlich für Projekte, die mit Build-Tools wie webpack, Babel oder TypeScript erstellt wurden, da es Ihnen ermöglicht, Ihre gebauten Dateien auf einem separaten gh-pages Branch in Ihrem Repository zu hosten.

Wie geht das mit gh-pages?

Installieren gh-pages

Zuerst müssen Sie das gh-pages Paket in Ihrem Projekt installieren. Sie können dies tun, indem Sie den folgenden Befehl in Ihrem Terminal ausführen:

npm install -D gh-pages

Dieser Befehl installiert gh-pages als Entwicklungsabhängigkeit in Ihrem Projekt.

Konfigurieren gh-pages

Nach der Installation müssen Sie ein Skript in Ihrer package.json Datei hinzufügen, um Ihre Webseite zu bauen und auf GitHub Pages zu veröffentlichen. Ein einfaches Beispiel könnte so aussehen:

"scripts": {
  "deploy": "gh-pages -d build --nojekyll"
}

In diesem Beispiel würde das deploy Skript das gh-pages Paket verwenden, um den Inhalt des build Verzeichnisses auf GitHub Pages zu veröffentlichen.

Verwenden gh-pages

Sobald Sie das gh-pages Paket installiert und konfiguriert haben, können Sie Ihre Webseite auf GitHub Pages veröffentlichen, indem Sie den folgenden Befehl in Ihrem Terminal ausführen:

npm run deploy

Dieser Befehl baut Ihre Webseite und veröffentlicht sie auf dem gh-pages Branch in Ihrem GitHub-Repository. GitHub Pages wird dann automatisch eine Webseite von den Dateien in diesem Branch erstellen.

Die Option --nojekyll

Die Option --nojekyll wird verwendet, um GitHub Pages zu signalisieren, dass es den Jekyll-Prozess überspringen soll, der normalerweise auf GitHub Pages läuft. Dies ist nützlich, wenn Ihre Webseite keine Jekyll-Features verwendet und Sie vermeiden möchten, dass GitHub Pages Ihre Webseite unnötigerweise mit Jekyll baut. Wenn Sie diese Option verwenden, erstellt gh-pages automatisch eine .nojekyll Datei im Root-Verzeichnis Ihres gh-pages Branches.