Skip to main content

GitHub Pages-Website mit Jekyll erstellen

Mit Jekyll kannst du eine GitHub Pages-Website in einem neuen oder bestehenden Repository erstellen.

Wer kann dieses Feature verwenden?

People with admin permissions for a repository can create a GitHub Pages site with Jekyll.

Platform navigation

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.

Hinweis: Organisationsbesitzer können die Veröffentlichung von GitHub Pages-Websites aus Repositorys im Besitz der Organisation einschränken. Weitere Informationen findest du unter Verwalten der Veröffentlichung von GitHub Pages-Websites für deine Organisation.

Voraussetzungen

Bevor du mit Jekyll eine GitHub Pages-Website erstellen kannst, musst du Jekyll und Git installieren. Weitere Informationen findest du unter Installation in der Jekyll-Dokumentation und unter Einrichten von Git.

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.

Ein Repository für eine Website erstellen

Du kannst entweder ein Repository erstellen oder ein vorhandenes Repository für deine Website auswählen.

Wenn du eine GitHub Pages-Website für ein Repository erstellen möchtest, wobei nicht alle Dateien im Repository mit der Website verknüpft sind, kannst du eine Veröffentlichungsquelle für deine Website konfigurieren. Du kannst z. B. einen dedizierten Branch und Ordner für deine Websitequelldateien einrichten oder einen benutzerdefinierten GitHub Actions-Workflow verwenden, um deine Websitequelldateien zu erstellen und zu bereitzustellen.

Wenn das Konto, dem das Repository angehört, GitHub Free oder GitHub Free für Organisationen verwendet, muss das Repository öffentlich sein.

Wenn du eine Website in einem vorhandenen Repository erstellen möchtest, fahre mit dem Abschnitt Erstellen deiner Website fort.

  1. Wähle in der rechten oberen Ecke einer beliebigen Seite , und klicke dann auf Neues Repository.

    Screenshot eines GitHub-Dropdownmenüs mit Optionen zum Erstellen neuer Elemente. Das Menüelement „Neues Repository“ ist in dunklem Orange eingerahmt.

  2. Verwende das Dropdownmenü Besitzer, um das Besitzerkonto für das Repository auszuwählen. Screenshot des Besitzermenüs für ein neues GitHub-Repository. Das Menü zeigt zwei Optionen, octocat und github.

    Hinweis: Wenn du ein verwaltetes Benutzerkonto verwendest, kannst du nur GitHub Pages-Websites aus Repositorys veröffentlichen, die im Besitz von Organisationen sind. Weitere Informationen findest du unter Informationen zu GitHub Pages.

  3. Gib einen Namen sowie eine optionale Beschreibung für Dein Repository ein. Wenn du eine Benutzer- oder Organisationswebsite erstellst, muss dein Repository <user>.github.io oder <organization>.github.io heißen. Wenn dein Benutzer- oder Organisationsname Großbuchstaben enthält, musst du diese als Kleinbuchstaben schreiben. Weitere Informationen findest du unter Informationen zu GitHub Pages. Screenshot der GitHub Pages-Einstellungen in einem Repository. Das Feld „Repositoryname“ enthält den Text „octocat.github.io“ und ist in dunklem Orange eingerahmt.

  4. Wähle eine Sichtbarkeitsoption für das Repository aus. Weitere Informationen findest du unter Informationen zu Repositorys.

Eine Website erstellen

Bevor du deine Website erstellen kannst, musst du ein Repository für deine Website auf GitHub Enterprise Cloud haben. Wenn du deine Website nicht in einem vorhandenen Repository erstellst, lies Erstellen eines Repositorys für deine Website.

Warnung: Wenn dein Unternehmen nicht Enterprise Managed Users verwendet, sind GitHub Pages-Websites standardmäßig öffentlich im Internet verfügbar, auch wenn das Repository für die Website privat oder intern ist. Du kannst eine Website privat veröffentlichen, indem du die Zugriffssteuerung für die Website verwaltest. Andernfalls sollten vertrauliche Daten im Repository deiner Website vor der Veröffentlichung entfernt werden. Weitere Informationen findest du unter Informationen zu Repositorys und unter Ändern der Sichtbarkeit der GitHub Pages-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-ORDNER 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/
    # Creates a new folder on your computer, initialized as a Git repository
    
  4. Wechsle in das Verzeichnis des Repositorys.

    $ cd REPOSITORY-NAME
    # Changes the working directory
    
  5. Entscheide, welche Veröffentlichungsquelle du verwenden möchtest. Weitere Informationen findest du unter Eine Veröffentlichungsquelle für deine GitHub Pages-Website konfigurieren.

  6. Navigiere zur Veröffentlichungsquelle für deine Website. Weitere Informationen findest du unter Eine Veröffentlichungsquelle für deine GitHub Pages-Website konfigurieren. Wenn du dich beispielsweise entschieden hast, deine Website aus dem docs-Ordner in der Standardverzweigung zu veröffentlichen, erstellen und verschiebe Verzeichnisse in den docs-Ordner.

    $ mkdir docs
    # Creates a new folder called docs
    $ cd docs
    

    If you chose to publish your site from the gh-pages branch, create and checkout the gh-pages branch.

    $ git checkout --orphan gh-pages
    # Creates a new branch, with no history or contents, called gh-pages, and switches to the gh-pages branch
    $ git rm -rf .
    # Removes the contents from your default branch from the working directory
    
  7. Um eine neue Jekyll-Website zu erstellen, verwendest du den jekyll new-Befehl:

    $ jekyll new --skip-bundle .
    # Creates a Jekyll site in the current directory
    
  8. Öffne die Gemfile, die Jekyll erstellt hat.

  9. Füge „#“ am Anfang der Zeile hinzu, die mit gem "jekyll" beginnt, um diese Zeile auszukommentieren.

  10. Füge das github-pages-Gem hinzu, indem du die Zeile mit # gem "github-pages" startest. Ändere diese Zeile zu:

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

    Ersetze GITHUB-PAGES-VERSION durch die neueste unterstützte Version des github-pages-Gems. Diese Version findest du hier: „Abhängigkeitsversionen".

    Die richtige Jekyll-Version wird als Abhängigkeit des github-pages-Gems installiert.

  11. Speichere und schließe das Gemfile.

  12. Führe bundle install über die Befehlszeile aus.

  13. Nimm optional alle erforderlichen Änderungen an der _config.yml-Datei vor. Dies ist für relative Pfade erforderlich, wenn das Repository in einem Unterverzeichnis gehostet wird. Weitere Informationen findest du unter Unterordner in ein neues Repository auslagern.

    domain: my-site.github.io       # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com
    url: https://my-site.github.io  # the base hostname and protocol for your site, e.g. http://example.com
    baseurl: /REPOSITORY-NAME/      # place folder name if the site is served in a subfolder
    
  14. Teste deine Website optional lokal. Weitere Informationen findest du unter Lokales Testen deiner GitHub Pages-Website mit Jekyll.

  15. Füge deine Arbeit hinzu und übernimm sie.

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
    
  16. Füge dein Repository auf GitHub.com als Remoterepository hinzu, ersetze USER durch das Konto, dem das Respository gehört und REPOSITORY durch den Namen des Repositorys.

    
    $ git remote add origin https://github.com/USER/REPOSITORY.git
    
    
  17. Übertrage das Repository zu GitHub Enterprise Cloud und ersetze dabei BRANCH durch den Namen des Branches, auf dem du gerade arbeitest.

    git push -u origin BRANCH
    
  18. Konfiguriere deine Veröffentlichungsquelle. Weitere Informationen finden Sie unter Eine Veröffentlichungsquelle für deine GitHub Pages-Website konfigurieren.

  19. Navigiere in GitHub Enterprise Cloud zum Repository Deiner Website.

  20. Wähle unter dem Namen deines Repositorys die Option Einstellungen aus. Wenn die Registerkarte „Einstellungen“ nicht angezeigt wird, wähle im Dropdownmenü die Option Einstellungen aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Einstellungen“ ist dunkelorange umrandet.

  21. Klicke im Abschnitt „Code und Automatisierung“ der Seitenleiste auf Seiten.

  22. Wenn du eine Website aus einem privaten oder internen Repository veröffentlichst, kannst du optional die Sichtbarkeit für deine Website auswählen. Wähle unter GitHub Pages das Dropdownmenü für Sichtbarkeit und dann entweder öffentlich oder privat aus. Weitere Informationen findest du unter Ändern der Sichtbarkeit der GitHub Pages-Website. Screenshot der Pages-Einstellungen in einem GitHub-Repository. Ein Menü zum Auswählen der privaten oder öffentlichen Sichtbarkeit der Pages-Website mit der Bezeichnung „Privat“ ist in dunklem Orange eingerahmt.

    Hinweis: Um eine GitHub Pages-Website privat zu veröffentlichen, muss deine Organisation GitHub Enterprise Cloud verwenden. Weitere Informationen zum kostenlosen Testen von GitHub Enterprise Cloud findest du unter Eine Testversion von GitHub Enterprise Cloud einrichten.

  23. Um deine veröffentlichte Website anzuzeigen, klicke unter „GitHub Pages“ auf Website besuchen. Screenshot einer Bestätigungsmeldung für GitHub Pages mit der URL der Website. Rechts neben der URL ist eine Schaltfläche mit der Beschriftung „Website besuchen“ in dunklem Orange eingerahmt.

    Hinweis: Nach dem Pushen der Änderung an GitHub Enterprise Cloud kann es bis zu 10 Minuten dauern, bis die Änderungen an deiner Website veröffentlicht werden. Wenn deine Änderungen an der GitHub Pages-Website nach einer Stunde noch nicht in deinem Browser angezeigt werden, findest du weitere Informationen unter Informationen zu Jekyll-Build-Fehler für GitHub Pages-Websites.

  24. Deine GitHub Pages-Website wird mit einem GitHub Actions-Workflow erstellt und bereitgestellt. Weitere Informationen findest du unter Anzeigen des Ausführungsverlaufs eines Workflows.

    Hinweis: GitHub Actions ist für öffentliche Repositorys kostenlos. Nutzungsgebühren gelten für private und interne Repositorys, die über das monatliche Kontingent kostenloser Minuten hinausgehen. Weitere Informationen findest du unter Nutzungseinschränkungen, Abrechnung und Verwaltung.

Hinweise:

  • Wenn die Veröffentlichung über einen Branch erfolgt und deine Website nicht automatisch veröffentlicht wurde, stelle sicher, dass jemand mit Administratorberechtigungen und einer verifizierten E-Mail-Adresse einen Push an die Veröffentlichungsquelle ausgeführt hat.

  • Commits, die von einem GitHub Actions-Workflow gepusht werden, der das GITHUB_TOKEN verwendet, lösen keinen GitHub Pages-Build aus.

Nächste Schritte

Informationen zum Hinzufügen einer neuen Seite oder eines Beitrags zu deiner Website 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 zur GitHub Pages-Website mit Jekyll hinzufügen.