Erstellen einer GitHub Pages-Website

Du kannst eine GitHub Pages-Website in einem neuen oder vorhandenen Repository erstellen.

Wer kann dieses Feature verwenden?

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.

GitHub Pages verwendet nun GitHub Actions zur Ausführung des Jekyll-Builds. Wenn Sie einen Zweig als Quelle Ihres Builds verwenden, muss GitHub Actions in Ihrem Repository aktiviert sein, wenn Sie den eingebauten Jekyll-Workflow verwenden möchten. Wenn GitHub Actions nicht verfügbar oder deaktiviert ist, können Sie alternativ eine .nojekyll-Datei zum Stamm Ihrer Quellverzweigung hinzufügen, um den Jekyll-Erstellungsprozess zu umgehen und den Inhalt direkt bereitzustellen. Weitere Informationen zur Aktivierung von GitHub Actions finden Sie unter „Verwalten von GitHub Actions-Einstellungen für ein Repository“

In diesem Artikel

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.

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.

  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.

  5. Aktivieren Sie das Kontrollkästchen Initialize this repository with a README (Dieses Repository mit einer README-Datei initialisieren).

  6. Klicke auf Repository erstellen.

Eine Website erstellen

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

Warnung: GitHub Pages-Websites sind im Internet öffentlich zugänglich, auch wenn das Repository für die Website privat ist (wenn Ihr Plan oder Ihre Organisation dies zulässt). Wenn das Repository deiner Website vertrauliche Daten enthält, solltest Du diese vor der Veröffentlichung entfernen. Weitere Informationen findest du unter Informationen zu Repositorys.

  1. Navigiere in GitHub zum Repository Deiner Website.

  2. Entscheide, welche Veröffentlichungsquelle du verwenden möchtest. Weitere Informationen findest du unter Eine Veröffentlichungsquelle für deine GitHub Pages-Website konfigurieren.

  3. Erstelle die Eintragsdatei für deine Website. GitHub Pages sucht nach einer index.html-, index.md- oder README.md-Datei als Eintragsdatei für deine Website.

    Wenn Ihre Veröffentlichungsquelle ein Branch und ein Ordner ist, muss sich die Eintragsdatei auf oberster Ebene des Quellordners im Quellbranch befinden. Wenn deine Veröffentlichungsquelle beispielsweise der Ordner /docs in Branch main ist, muss sich deine Eintragsdatei im Ordner /docs in einem Branch namens main befinden.

    Wenn deine Veröffentlichungsquelle ein GitHub Actions-Workflow ist, muss das von dir bereitgestellte Artefakt die Eintragsdatei auf oberster Ebene des Artefakts enthalten. Anstatt die Eintragsdatei Ihrem Repository hinzuzufügen, können Sie Ihren GitHub Actions-Workflow Ihre Eintragsdatei generieren lassen, wenn der Workflow ausgeführt wird.

  4. Konfiguriere deine Veröffentlichungsquelle. Weitere Informationen finden Sie unter Eine Veröffentlichungsquelle für deine GitHub Pages-Website konfigurieren.

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

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

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

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

Note

  • 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

Du kannst deiner Website weitere Seiten hinzufügen, indem du zusätzliche neue Dateien erstellst. Jede Datei ist auf deiner Website im selben Verzeichnis verfügbar wie deine Veröffentlichungsquelle. Wenn beispielsweise die Veröffentlichungsquelle für deine Projektwebsite der Branch gh-pages ist, und du eine neue Datei namens /about/contact-us.md in Branch gh-pages erstellst, steht die Datei unter https://<user>.github.io/<repository>/about/contact-us.html zur Verfügung.

Du kannst auch ein Design hinzufügen, um das Aussehen der Website anzupassen. Weitere Informationen findest du unter Ein Design zur GitHub Pages-Website mit Jekyll hinzufügen.

Um deine Website noch weiter anzupassen, kannst du Jekyll verwenden, einen Generator für statische Websites mit integrierter Unterstützung von GitHub Pages. Weitere Informationen findest du unter Informationen zu GitHub Pages und Jekyll.

Weiterführende Themen