Testen Ihrer GitHub Pages-Website lokal mit Jekyll

Jeder Benutzer mit Leseberechtigungen für ein Repository kann eine GitHub Pages Website lokal testen.

Voraussetzungen

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

• Jekyll installiert.
• Erstelle eine Jekyll-Website. Weitere Informationen finden Sie unter Erstellen einer GitHub Pages-Website mit Jekyll.

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.

Website lokal erstellen

1. Öffne TerminalTerminalGit Bash.

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

3. Führen Sie bundle install aus.

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.
   

   Hinweis

   • 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 Sie Ruby 3.2 oder neuer installiert haben, werden möglicherweise aufgrund von Kompatibilitätsproblemen mit dem github-pages Gem andere Fehler im Zusammenhang mit fehlenden Gems und Methoden angezeigt. In diesem Ereignis sollten Sie Stattdessen Ruby 3.1.x oder früher installieren.

   • Wenn das _config.yml-Feld deiner baseurl-Datei den Link zu deinem GitHub-Repository enthält, können Sie den folgenden Befehl verwenden, um diesen Wert lokal zu ignorieren und die Website auf localhost:4000/ hosten:

     bundle exec jekyll serve --baseurl=""
     

5. Um eine Vorschau deiner Website anzuzeigen, navigiere in deinem Webbrowser zu http://localhost:4000.

Das GitHub PagesGem aktualisieren

Jekyll ist ein aktives Open Source Projekt, das häufig aktualisiert wird. Wenn die auf Ihrem Computer installierte github-pages-Gem nicht mehr auf dem neuesten Stand der github-pages-Gem auf dem GitHub Pages-Server entspricht, sieht Ihre Website bei der lokalen Erstellung möglicherweise anders aus als bei der Veröffentlichung auf 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 Lektüre

• GitHub Pages in der Dokumentation zu Jekyll