GitHub Pages-Website mit Jekyll erstellen

Voraussetzungen

Bevor Sie mit Jekyll eine GitHub Pages-Website erstellen können, müssen Sie Jekyll und Git installieren. Weitere Informationen finden Sie unter „Installation“ in der Jekyll-Dokumentation und unter „Git einrichten“.

Zur Installation und Ausführung von Jekyll empfehlen wir Bundler. Bundler verwaltet „Ruby gem"-Abhängigkeiten, reduziert Jekyll-Build-Fehler und verhindert umgebungsspezifische Bugs. Um Bundler zu installieren:

1. Installiere Ruby. Weitere Informationen findest Du unter „Installieren von Ruby" in der Ruby-Dokumentation.
2. Installieren Sie Bundler. Weitere Informationen findest Du unter „Bundler."

Ein Repository für eine Website erstellen

Wenn Deine Website ein unabhängiges Projekt ist, kannst Du ein neues Repository erstellen, um den Quellcode Deiner Website zu speichern. Wenn Deine Website einem existierenden Projekt zugeordnet ist, kannst Du den Quellcode für Deine Website zu einem gh-pages-Branch oder einem docs-Ordner im master-Branch dieses Projekt-Repository hinzufügen. Wenn Du beispielsweise eine Website erstellst, um Dokumentationen für ein Projekt zu veröffentlichen, das bereits auf GitHub Enterprise ist, kannst Du den Quellcode für die Website im selben Repository wie das Projekt speichern.

Wenn Du eine Website in einem vorhandenen Repository erstellen möchtest, springe zum Abschnitt „Erstellen Deiner Website".

1. Benutze in der oberen rechten Ecke einer beliebigen Seite das -Dropdownmenü und wähle New Repository (Neues Repository).
   
2. Verwende das Dropdownmenü Owner (Inhaber) und wähle das Konto, das das Repository besitzen soll.
   
3. Gib einen Namen sowie eine optionale Beschreibung für Dein Repository ein. Wenn Du eine Benutzer- oder Organisationswebsite erstellst, muss Dein Repository den Namen <user>.github.io or <organization>.github.io haben. Weitere Informationen findest Du unter „Informationen zu GitHub Pages“.
   
4. Wähle die Sichtbarkeit des Repository. Weitere Informationen findest Du unter „Über Sichtbarkeit von Repositorys."
   

Eine Website erstellen

Bevor Du Deine Website erstellen kannst, musst Du ein Repository für Deine Website auf GitHub Enterprise haben. Wenn Du Deine Website nicht in einem vorhandenen Repository erstellst, findest Du weitere Informationen unter „Erstellen eines Repositorys für Deine Website."

1. Öffne TerminalTerminalGit Bash.

2. Wenn Sie noch keine lokale Kopie Ihres Repositorys besitzen, navigieren Sie zu dem Speicherort, an dem Sie die Quelldateien Ihrer Website speichern möchten, und ersetzen dabei PARENT-FOLDER durch den Ordner, der den Ordner für Ihr Repository enthalten soll.

   $ cd PARENT-FOLDER

3. Wenn Sie dies noch nicht getan haben, initialisieren Sie ein lokales Git-Repository, und ersetzen dabei REPOSITORY-NAME durch den Namen Ihres Repositorys.

   $ git init REPOSITORY-NAME
   > Initialized empty Git repository in /Users/octocat/my-site/.git/
   # Erstellt einen neuen Ordner auf Ihrem Computer, der als Git-Repository initialisiert wird

4. Wechseln Sie in das Verzeichnis des Repositorys.

   $ cd REPOSITORY-NAME
   # Ändert das Arbeitsverzeichnis

5. Wenn Du eine Projektwebsite erstellst, entscheide, welche Veröffentlichungsquelle Du verwenden möchtest. Wenn Du eine Benutzer- oder Organisations-Website erstellst, musst Du den Quellcode Deiner Website im master-Branch speichern. Weitere Informationen findest Du unter „Über GitHub Pages."

6. Navigiere zur Veröffentlichungsquelle für Deine Website. Weitere Informationen zu Veröffentlichungsquellen findest Du unter „Informationen zu GitHub Pages“. Wenn Sie z. B. Ihre Website aus dem Ordner docs auf dem master-Branch veröffentlichen möchten, erstellen Sie den Ordner docs und wechseln in dieses Verzeichnis.

   $ mkdir docs
   # Erstellt einen neuen Ordner mit dem Namen docs
   $ cd docs

   Wenn Sie Ihre Website aus dem gh-pages-Branch veröffentlichen möchten, erstellen Sie den gh-pages-Branch und checken ihn aus.

   $ git checkout --orphan gh-pages
   # Erstellt einen neuen Branch, ohne Verlauf und Inhalte, mit dem namen gh-pages und wechselt zum gh-pages-Branch

7. Um eine neue Jekyll-Website zu erstellen, führen Sie den Befehl jekyll new aus. Ersetzen Sie dabei VERSION durch die aktuelle Abhängigkeitsversion für Jekyll. Weitere Informationen finden Sie unter „Abhängigkeitsversionen“ auf der GitHub Pages-Website.

   • Wenn Sie Bundler installiert haben:

     $ bundle exec jekyll VERSION new .
     # Erstellt eine Jekyll-Website im aktuellen Verzeichnis

   • Wenn Sie Bundler nicht installiert haben:

     $ jekyll VERSION new .
     # Erstellt eine Jekyll-Website im aktuellen Verzeichnis

8. Öffnen Sie die erstellte Gemfile, und befolgen Sie die Anweisungen in den Gemfile-Kommentaren, um GitHub Pages zu verwenden.

   

9. Aktualisieren Sie die Zeile gem "github-pages" so, dass sie wie folgt aussieht. Ersetzen Sie dabei VERSION durch die aktuelle Abhängigkeitsversion für github-pages. Weitere Informationen finden Sie unter „Abhängigkeitsversionen“ auf der GitHub Pages-Website.

   gem "github-pages", "~> VERSION", group: :jekyll_plugins

10. Speichern und schließen Sie die Gemfile.

11. Testen Sie Ihre Website optional lokal. Weitere Informationen finden Sie unter „GitHub Pages-Website lokal mit Jekyll testen“.

12. Fügen Sie Ihr GitHub Enterprise-Repository als Remote-Repository hinzu. Ersetzen Sie dabei HOSTNAME durch den Hostnamen Ihrer Appliance, USER durch das Konto, das das Repository besitzt, und REPOSITORY durch den Namen des Repositorys.

    $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
    

13. Pushen Sie das Repository zu GitHub Enterprise, und ersetzen Sie dabei BRANCH durch den Namen des Branches, auf dem Sie gerade arbeiten.

    $ git push -u origin BRANCH

14. Wenn Du eine nicht standardmäßige Veröffentlichungsquelle für eine Projektwebsite verwendest, konfiguriere Deine Veröffentlichungsquelle. Weitere Informationen findest Du unter „Eine Veröffentlichungsquelle für Deine GitHub Pages-Website konfigurieren.“

15. Navigiere in GitHub Enterprise zum Repository Deiner Website.

16. Klicke unter Deinem Repository-Namen auf Settings (Einstellungen).

    

17. Um Deine veröffentlichte Website anzuzeigen, klicke unter „GitHub Pages" auf die URL Deiner Website.

    

    Hinweis: Es kann bis zu 20 Minuten dauern, bis die Änderungen auf Deiner Website veröffentlicht werden, nachdem Du die Änderungen zu GitHub Enterprise übertragen hast. Wenn Deine Änderungen nach einer Stunde in Deinem Browser nicht angezeigt werden, findest Du weitere Informationen unter „Über Jekyll-Build-Fehler für GitHub Pages-Websites."

Nächste Schritte:

Informationen dazu, wie Sie eine neue Seite oder einen neuen Beitrag zu Ihrer Website hinzufügen, finden Sie unter „Inhalte zur GitHub Pages-Website mit Jekyll hinzufügen“.

Du kannst zu Deiner GitHub Pages-Website ein Jekyll-Design hinzufügen, um das Erscheinungsbild Deiner Website anzupassen. Weitere Informationen finden Sie unter „Ein Design zu Ihrer GitHub Pages-Website mit Jekyll hinzufügen“.