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.

Who can use this feature

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

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-Produkte.

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.

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 in 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. Verwende in der oberen rechten Ecke einer beliebigen Seite das -Dropdownmenü, und wähle Neues Repository aus. Dropdownmenü mit der Option zum Erstellen eines neuen Repositorys 1. Verwende das Dropdownmenü Besitzer, und wähle das Besitzerkonto für das Repository aus. Dropdownmenü „Besitzer“
    Hinweis: Wenn du ein managed user account 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.
    1. Gib einen Namen sowie eine optionale Beschreibung für Dein Repository ein. Wenn du eine Benutzer- oder Organisationswebsite erstellst, muss dein Repository `.github.io` oder `.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](/articles/about-github-pages#types-of-github-pages-sites). ![Feld „Repository erstellen“](/assets/images/help/pages/create-repository-name-pages.png) 1. Wähle eine Sichtbarkeitsoption für das Repository aus. Weitere Informationen findest du unter [Informationen zu Repositorys](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility). ![Optionsfelder zum Auswählen der Repositorysichtbarkeit](/assets/images/help/repository/create-repository-public-private.png)

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 Ändern der Sichtbarkeit deiner 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 Konfigurieren einer Veröffentlichungsquelle für deine GitHub Pages-Website. 1. Navigiere zur Veröffentlichungsquelle für deine Website. Weitere Informationen findest du unter Konfigurieren einer Veröffentlichungsquelle für deine GitHub Pages-Website. 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

    Wenn du deine Website aus der gh-pages-Verzweigung veröffentlichen möchtest, erstelle die Verzweigung und prüfe die gh-pages-Verzweigung.

    $ 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
  6. 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
  7. Öffne die Gemfile, die Jekyll erstellt hat.

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

  9. 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.

  10. Speichere und schließe das Gemfile.

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

  12. 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 Aufteilen eines Unterordners in ein neues Repository.

    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
    
  13. Teste deine Website optional lokal. Weitere Informationen findest du unter Lokales Testen deiner GitHub Pages-Website mit Jekyll.

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

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
  15. 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
    
  16. Ü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
  17. Konfiguriere deine Veröffentlichungsquelle. Weitere Informationen findest du unter Konfigurieren einer Veröffentlichungsquelle für deine GitHub Pages-Website. 1. Navigiere in GitHub Enterprise Cloud zum Repository Deiner Website. 1. Klicke unter dem Repositorynamen auf Einstellungen. Schaltfläche „Repositoryeinstellungen“

  18. Klicke auf der Randleiste im Abschnitt „Code und Automatisierung“ auf Seiten.

  19. 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ü GitHub Pages-Sichtbarkeit aus, und klicke dann auf eine Sichtbarkeit. Weitere Informationen findest Du unter Ändern der Sichtbarkeit deiner GitHub Pages-Website. Dropdownliste zum Auswählen einer Sichtbarkeit für deine Website

      <div class="extended-markdown note border rounded-1 mb-4 p-3 color-border-accent-emphasis color-bg-accent f5">
    

    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.

    1. Um deine veröffentlichte Website anzuzeigen, klicke unter „GitHub Pages“ auf ** Website besuchen**. ![Screenshot: Schaltfläche Website besuchen neben der URL einer veröffentlichten Website](/assets/images/help/pages/click-pages-url-to-preview.png)

    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 GitHub Pages-Websiteänderungen nach einer Stunde noch immer nicht in deinem Browser angezeigt werden, lies die Informationen zu Jekyll-Buildfehlern für GitHub Pages-Websites.

  20. Deine GitHub Pages-Website wird mit einem GitHub Actions-Workflow erstellt und bereitgestellt. Weitere Informationen findest du unter Anzeigen des Workflowausführungsverlaufs.

    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.

Hinweis: 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.

Nächste Schritte

Informationen zum Hinzufügen einer neuen Seite oder eines Beitrags zu deiner Website findest du unter Hinzufügen von Inhalten zu deiner GitHub Pages-Website mithilfe von Jekyll.

Du kannst zu Deiner GitHub Pages-Website ein Jekyll-Design hinzufügen, um das Erscheinungsbild Deiner Website anzupassen. Weitere Informationen findest du unter Hinzufügen eines Designs zu deiner GitHub Pages-Website mithilfe von Jekyll.