Informationen zu GitHub Pages
GitHub Pages ist ein Hosting-Dienst für statische Websites, der HTML-, CSS- und JavaScript-Dateien direkt aus einem Repository auf GitHub Enterprise bezieht, diese Dateien optional einem Build-Prozess unterzieht und eine Website veröffentlicht. Beispiele für GitHub Pages-Websites findest Du in der GitHub Pages-Beispielsammlung.
Informationen zu den ersten Schritten findest Du unter „Eine GitHub Pages-Website erstellen.“
Arten von GitHub Pages-Websites
Es gibt drei Arten von GitHub Pages-Websites: Projekt-, Benutzer- und Organisations-Websites. Projekt-Websites sind mit einem bestimmten Projekt verbunden, das auf GitHub Enterprise gehostet wird, z. B. einer JavaScript-Bibliothek oder einer Rezeptsammlung. Benutzer- und Organisations-Websites sind mit einem bestimmten GitHub Enterprise-Konto verbunden.
Um eine Benutzerwebsite zu veröffentlichen, musst Du ein Repository erstellen, das Deinem Benutzerkonto gehört und den Namen <user>.<hostname>
hat. Um eine Organisations-Website zu veröffentlichen, musst du ein Repository erstellen, das einer Organisation gehört, die <organization>.<hostname>
heißt.
Die Quelldateien für eine Projekt-Website werden im selben Repository gespeichert wie das zugehörige Projekt.
Du kannst für jedes GitHub Enterprise-Konto nur eine Benutzer- oder Organisations-Website erstellen. Für Projekt-Websites gibt es keine Beschränkung, egal, ob sie einer Organisation oder einem Benutzerkonto gehören.
Unter welcher URL Deine Website erreichbar ist, hängt davon ab, ob die Subdomänen-Isolation für Ihre GitHub Enterprise Server-Instanz aktiviert ist.
Art der Website | Subdomänen-Isolation aktiviert | Subdomänen-Isolation deaktiviert |
---|---|---|
Benutzer |
http(s)://pages.<hostname>/<username>/<repository>/
| http(s)://<hostname>/pages/<username>/<repository>/
| Organisation | http(s)://pages.<hostname>/<organization>/<repository>/
| http(s)://<hostname>/pages/<organization>/<repository>/
| Projekt-Website, die einem Benutzerkonto gehört | http(s)://pages.<hostname>/<username>/<repository>/
| http(s)://<hostname>/pages/<username>/<repository>/
Projekt-Website, die einem Organisations-Konto gehört | http(s)://pages.<hostname>/<orgname>/<repository>/
| http(s)://<hostname>/pages/<orgname>/<repository>/
Weitere Informationen findest Du unter „Subdomänen-Isolation aktivieren“. Bei Fragen kannst Du Dich auch an den Websiteadministrator wenden.
Veröffentlichungsquellen für GitHub Pages-Websites
The publishing source for your GitHub Pages site is the branch and folder where the source files for your site are stored. All sites have a default publishing source, and project sites have additional publishing sources available.
Warnung: GitHub Pages-Websites sind im Internet öffentlich zugänglich wenn Dein Websiteadministrator „Public Pages" (Öffentliche Seiten) aktiviert hat, auch wenn ihre Repositorys privat sind. Wenn Du sensitive Daten im Repository Deiner Website hast, solltest Du diese vor der Veröffentlichung entfernen. Weitere Informationen findest Du unter „Konfigurieren GitHub Pages auf Deiner Appliance" und „Über die Sichtbarkeit des Repositorys."
Die standardmäßige Veröffentlichungsquelle für Benutzer- und Organisations-Websites ist der master
-Branch. Wenn das Repository Deiner Benutzer- oder Organisations-Website einen master
-Branch aufweist, wird Deine Website automatisch von diesem Branch veröffentlicht. Du kannst keine andere Veröffentlichungsquelle für Benutzer- oder Organisations-Websites auswählen.
Die standardmäßige Veröffentlichungsquelle für Projekt-Websites ist der gh-pages
-Branch. Wenn das Repository Deiner Projekt-Website einen gh-pages
-Branch aufweist, wird Deine Website automatisch von diesem Branch veröffentlicht.
Du kannst Projekt-Websites auch vom master
-Branch oder einem /docs
-Ordner auf dem master
-Branch veröffentlichen. Um Deine Website aus einer dieser Quellen zu veröffentlichen, musst Du eine andere Veröffentlichungsquelle konfigurieren. Weitere Informationen findest Du unter „Eine Veröffentlichungsquelle für Deine GitHub Pages-Website konfigurieren.“
Wenn Du den /docs
-Ordner des master
-Branches als Veröffentlichungsquelle auswählst, liest GitHub Pages alle Informationen, die zum Veröffentlichen Deiner Website erforderlich sind, aus dem /docs
-Ordner.
Du kannst Deine Projekt-Website nicht aus einem anderen Branch veröffentlichen, auch wenn der Standard-Branch nicht Master
oder gh-pages
ist.
Generatoren für statische Websites
GitHub Pages veröffentlicht alle statischen Dateien, die Du zu Deinem Repository überträgst. 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 Build-Prozess lokal oder auf einem anderen Server anpassen. Wir empfehlen Jekyll, einen Generator für statische Websites mit integrierter Unterstützung von GitHub Pages und einem vereinfachten Build-Prozess. Weitere Informationen findest Du unter „Informationen zu GitHub Pages und Jekyll.“
GitHub Pages verwendet standardmäßig Jekyll für die Erstellung Deiner Website. Wenn Du anstelle von Jekyll einen anderen Generator für statische Websites verwenden möchtest, musst Du den Jekyll-Build-Prozess deaktivieren. Erstelle dazu im Root Deiner Veröffentlichungsquelle eine leere Datei mit dem Namen .nojekyll
und folge den Anweisungen des gewünschten Generators, um Deine Website lokal zu erstellen.
GitHub Pages unterstützt keine serverseitigen Sprachen wie PHP, Ruby oder Python.
Richtlinien für die Verwendung von GitHub Pages
GitHub Pages unterliegen den folgenden Nutzungseinschränkungen:
- Für GitHub Pages-Quell-Repositorys gilt eine empfohlene Beschränkung von 1 GB.
- Veröffentlichte GitHub Pages-Websites dürfen nicht größer als 1 GB sein.
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 erzeugt.
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 Beitragsrichtlinien für mime-db.
Weiterführende Informationen
- GitHub Pages auf GitHub Learning Lab
- "GitHub Pages"