GitHub Pages-Website mit Jekyll erstellen

Voraussetzungen

Bevor Du mit Jekyll eine GitHub Pages-Website erstellen kannst, musst Du 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. If your site is associated with an existing project, you can add the source code for your site to a gh-pages branch or a docs folder on the master branch in that project's repository. For example, if you're creating a site to publish documentation for a project that's already on GitHub Enterprise, you may want to store the source code for the site in the same repository as the project.

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. Choose a repository visibility. 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 Du noch keine lokale Kopie Deines Repositorys besitzt, navigiere zu dem Speicherort, an dem Du die Quelldateien Deiner Website speichern möchtest, und ersetze dabei PARENT-FOLDER durch den Ordner, der den Ordner für Dein Repository enthalten soll.

   $ cd PARENT-FOLDER

3. Wenn Du dies noch nicht getan hast, initialisiere ein lokales Git-Repository, und ersetzen dabei REPOSITORY-NAME durch den Namen Deines Repositorys.

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

4. Wechsle in das Verzeichnis des Repositorys.

   $ cd REPOSITORY-NAME
   # Ändert das Arbeitsverzeichnis

5. If you're creating a project site, decide which publishing source you want to use. If you're creating a user or organization site, you must store your site's source code on the master branch. For more information, see "About GitHub Pages."

6. Navigiere zur Veröffentlichungsquelle für Deine Website. Weitere Informationen zu Veröffentlichungsquellen findest Du unter „Informationen zu GitHub Pages“. For example, if you chose to publish your site from the docs folder on the default branch, create and change directories to the docs folder.

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

   Wenn Du Deine Website aus dem gh-pages-Branch veröffentlichen möchtest, erstelle den gh-pages-Branch und checke 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ühre den Befehl jekyll new aus. Ersetze dabei VERSION durch die aktuelle Abhängigkeitsversion für Jekyll. Weitere Informationen findest Du unter „Abhängigkeitsversionen“ auf der GitHub Pages-Website.

   • Wenn Du Bundler installiert hast:

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

   • Wenn Du Bundler nicht installiert hast:

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

8. Öffne das gerade erstellte Gemfile, und befolge die Anweisungen in den Gemfile-Kommentaren, um GitHub Pages zu verwenden.

   

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

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

10. Speichere und schließe das Gemfile.

11. Teste Deine Website optional lokal. Weitere Informationen findest Du unter „GitHub Pages-Website lokal mit Jekyll testen.“

12. Füge Dein GitHub Enterprise-Repository als Remote-Repository hinzu. Ersetze dabei HOSTNAME durch den Hostnamen Deiner 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. Übertrage das Repository zu GitHub Enterprise, und ersetze dabei BRANCH durch den Namen des Branches, auf dem Du gerade arbeitest.

    $ git push -u origin BRANCH

14. Configure your publishing source. 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 Du eine neue Seite oder einen neuen Beitrag zu Deiner Website hinzufügst, findest Du 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 findest Du unter „Ein Design zu Deiner GitHub Pages-Website mit Jekyll hinzufügen.“