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.

In diesem Artikel

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 bereitzustellen. Um GitHub Actions als Veröffentlichungsquelle für GitHub Pages zu verwenden, muss ein Siteadministrator GitHub Actions für GitHub Enterprise Server aktivieren. Weitere Informationen findest du unter Aktivieren von GitHub Actions für GitHub Enterprise Server.

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

Wähle in der rechten oberen Ecke einer beliebigen Seite , und klicke dann auf Neues Repository.
Verwende das Dropdownmenü Besitzer, um das Besitzerkonto für das Repository auszuwählen.
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 finden Sie unter What is GitHub Pages?.
Wähle eine Sichtbarkeitsoption für das Repository aus. Weitere Informationen finden Sie unter Informationen zu Repositorys.
Aktivieren Sie das Kontrollkästchen Initialize this repository with a README (Dieses Repository mit einer README-Datei initialisieren).
Klicke auf Repository erstellen.

Eine Website erstellen

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

Warnung

Wenn dein Websiteadministrator öffentliche Seiten aktiviert hat, sind GitHub Pages-Websites öffentlich im Internet verfügbar, auch wenn das zugehörige Repository privat oder intern ist. Wenn das Repository deiner Website vertrauliche Daten enthält, solltest Du diese vor der Veröffentlichung entfernen. Weitere Informationen findest du unter Konfigurieren von GitHub Seiten für dein Unternehmen und Informationen zu Repositorys.

Navigiere auf GitHub zum Repository deiner Website.
Entscheide, welche Veröffentlichungsquelle du verwenden möchtest. Weitere Informationen findest du unter Eine Veröffentlichungsquelle für deine GitHub Pages-Website konfigurieren.
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.
Konfiguriere deine Veröffentlichungsquelle. Weitere Informationen findest du unter Eine Veröffentlichungsquelle für deine GitHub Pages-Website konfigurieren.

Anzeigen deiner veröffentlichten Website

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.
Klicke im Abschnitt „Code und Automatisierung“ der Seitenleiste auf Seiten.
Klicke zum Anzeigen deiner veröffentlichten Website unter „GitHub Pages“ auf Visit site.

Hinweis

Es kann bis zu 10 Minuten dauern, bis die Änderungen an deiner Website, die du per Push an GitHub übertragen hast, 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.

Wenn du die Veröffentlichung über einen Branch durchführst und deine Website nicht automatisch veröffentlicht wurde, stelle sicher, dass jemand mit Adminberechtigungen und einer verifizierten E-Mail-Adresse einen Push an die Veröffentlichungsquelle durchgeführt hat.
Commits, die von einem GitHub Actions-Workflow gepusht werden, der das GITHUB_TOKEN verwendet, lösen keinen GitHub Pages-Build aus.

Generatoren für statische Websites

GitHub Pages veröffentlicht alle statischen Dateien, die du an dein Repository pushst. Du kannst eigene statische Dateien erstellen oder einen Generator für statische Websites verwenden, der die Website für dich erstellt. Darüber hinaus kannst du deinen eigenen Buildprozess lokal oder auf einem anderen Server anpassen.

Wenn du statt Jekyll einen benutzerdefinierten Buildprozess oder einen anderen Generator für statische Websites verwendest, kannst du einen GitHub Actions-Workflow schreiben, um deine Website zu erstellen und zu veröffentlichen. GitHub bietet Workflowvorlagen für verschiedene Generatoren für statische Websites. Weitere Informationen finden Sie unter Eine Veröffentlichungsquelle für deine GitHub Pages-Website konfigurieren.

Wenn du deine Website von einem Quellbranch aus veröffentlichst, verwendet GitHub Pages standardmäßig Jekyll zum Erstellen deiner Website. Wenn du statt Jekyll einen anderen Generator für statische Websites verwenden möchtest, empfehlen wir, stattdessen GitHub Actions zu schreiben, um deine Website zu erstellen und zu veröffentlichen. Anderenfalls deaktiviere den Jekyll-Buildprozess, indem du im Stamm deiner Veröffentlichungsquelle eine leere Datei namens .nojekyll erstellst, und befolge dann die Anweisungen des gewünschten Generators für statische Websites, um deine Website lokal zu erstellen.

Hinweis

GitHub Pages unterstützt keine serverseitigen Sprachen wie PHP, Ruby oder Python.

MIME-Typen auf GitHub Pages

Ein MIME-Typ ist ein Header, den ein Server an einen Browser übermittelt und der Informationen zur Art und zum Format der Dateien enthält, die der Browser angefordert hat. GitHub Pages unterstützt mehr als 750 MIME-Typen bei Tausenden von Dateierweiterungen. Die Liste der unterstützten MIME-Typen wird aus dem Mime-db-Projekt generiert.

Zwar kannst du keine benutzerdefinierten MIME-Typen für einzelne Dateien oder Repositorys festlegen, aber du kannst MIME-Typen für die Verwendung auf GitHub Pages hinzufügen oder ändern. Weitere Informationen findest du in den Mime-db-Richtlinien.

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 http(s)://<hostname>/pages/<username>/<repository>/about/contact-us.html zur Verfügung.

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