GitHub Pages-Website lokal mit Jekyll testen

Du kannst deine GitHub Pages-Website lokal erstellen, um Änderungen an deiner Website vorab anzuzeigen und zu testen.

Wer kann dieses Feature verwenden?

GitHub Pages ist in öffentlichen Repositorys mit GitHub Free und GitHub Free für Organisationen sowie in öffentlichen und privaten Repositorys mit GitHub Pro, GitHub Team, GitHub Enterprise Cloud und GitHub Enterprise Server verfügbar. Weitere Informationen findest du unter GitHub-Pläne.

GitHub Pages verwendet nun GitHub Actions zur Ausführung des Jekyll-Builds. Wenn Sie einen Zweig als Quelle Ihres Builds verwenden, muss GitHub Actions in Ihrem Repository aktiviert sein, wenn Sie den eingebauten Jekyll-Workflow verwenden möchten. Wenn GitHub Actions nicht verfügbar oder deaktiviert ist, können Sie alternativ eine .nojekyll-Datei zum Stamm Ihrer Quellverzweigung hinzufügen, um den Jekyll-Erstellungsprozess zu umgehen und den Inhalt direkt bereitzustellen. Weitere Informationen zur Aktivierung von GitHub Actions finden Sie unter „Verwalten von GitHub Actions-Einstellungen für ein Repository“

Platform navigation

In diesem Artikel

Personen mit Schreibberechtigungen für ein Repository können eine GitHub Pages-Website lokal testen.

Voraussetzungen

Bevor du mit Jekyll eine Website testen kannst, müssen folgende Voraussetzungen erfüllt sein:

Es wird empfohlen, Bundler zum Installieren und Ausführen von Jekyll zu verwenden. Bundler verwaltet „Ruby gem"-Abhängigkeiten, reduziert Jekyll-Build-Fehler und verhindert umgebungsspezifische Bugs. Um Bundler zu installieren:

  1. Ruby installieren. Weitere Informationen findest du unter Installieren von Ruby in der Ruby-Dokumentation.
  2. Installiere Bundler. Weitere Informationen findest du unter Bundler.

Tipp: Wenn bei dem Versuch, Jekyll mithilfe von Bundler zu installieren, ein Ruby-Fehler angezeigt wird, musst du möglicherweise einen Paket-Manager wie RVM oder Homebrew verwenden, um deine Ruby-Installation zu verwalten. Weitere Informationen findest du in der Jekyll-Dokumentation unter Problembehandlung.

Website lokal erstellen

  1. Öffne TerminalTerminalGit Bash.

  2. Navigiere zur Veröffentlichungsquelle für deine Website. Weitere Informationen findest du unter Eine Veröffentlichungsquelle für deine GitHub Pages-Website konfigurieren.

  3. Führe aus bundle install.

  4. Führe dein Jekyll-Website lokal aus.

    $ bundle exec jekyll serve
> Configuration file: /Users/octocat/my-site/_config.yml
>            Source: /Users/octocat/my-site
>       Destination: /Users/octocat/my-site/_site
> Incremental build: disabled. Enable with --incremental
>      Generating...
>                    done in 0.309 seconds.
> Auto-regeneration: enabled for '/Users/octocat/my-site'
> Configuration file: /Users/octocat/my-site/_config.yml
>    Server address: http://127.0.0.1:4000/
>  Server running... press ctrl-c to stop.

    Hinweise:

    • Wenn Sie Ruby 3.0 oder höher installiert haben (was der Fall sein kann, wenn Sie die Standardversion über Homebrew installiert haben), wird in diesem Schritt unter Umständen eine Fehlermeldung angezeigt. Das liegt daran, dass diese Versionen von Ruby nicht mehr mit webrick installiert werden.

      Um den Fehler zu beheben, versuche bundle add webrick auszuführen, und führe dann erneut bundle exec jekyll serve aus.

    • Wenn das Feld baseurl der Datei _config.yml den Link Ihres GitHub-Repositorys enthält, können Sie beim lokalen Erstellen den folgenden Befehl verwenden, um den betreffenden Wert zu ignorieren und die Site unter localhost:4000/ zu bedienen:

      bundle exec jekyll serve --baseurl=""

  5. Navigiere zum Anzeigen deiner Website in deinem Webbrowser zu http://localhost:4000.

Das GitHub Pages-Gem aktualisieren

Jekyll ist ein aktives Open-Source-Projekt, das regelmäßig aktualisiert wird. Wenn das Gem github-pages auf deinem Computer älter ist als das Gem github-pages auf dem GitHub Pages-Server, sieht deine Website beim lokalen Build möglicherweise anders aus als bei Veröffentlichung in GitHub. Um dies zu vermeiden, aktualisiere das Gem github-pages auf deinem Computer regelmäßig.

  1. Öffne TerminalTerminalGit Bash.
  2. Aktualisiere das Gem github-pages.
    • Wenn du Bundler installiert hast, führe bundle update github-pages aus.
    • Wenn Bundler nicht installiert ist, führe gem update github-pages aus.

Weiterführende Themen