GitHub Pages-Website mit Jekyll erstellen

Sie können mit Jekyll eine GitHub Pages-Website in einem neuen oder vorhandenen Repository erstellen.

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

GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server.

Note: Organization owners can restrict the publication of GitHub Pages sites from repositories owned by the organization. For more information, see "Managing the publication of GitHub Pages sites."

Vorrausetzungen

Bevor Sie mit Jekyll eine GitHub Pages-Website erstellen können, müssen Sie Jekyll und Git installieren. Weitere Informationen findest Du unter „Installation“ in der Jekyll-Dokumentation und unter „Git einrichten.“

Zur Installation und Ausführung von Jekyll empfehlen wir Bundler. Bundler verwaltet „Ruby gem"-Abhängigkeiten, reduziert Jekyll-Build-Fehler und verhindert umgebungsspezifische Bugs. Um Bundler zu installieren:

  1. Installiere Ruby. Weitere Informationen findest Du unter „Installieren von Ruby" in der Ruby-Dokumentation.
  2. Installieren Sie Bundler. Weitere Informationen findest Du unter „Bundler."

Tipp: Wenn während der Installation von Jekyll mit Bundler ein Ruby-Fehler ausgegeben wird, benötigst Du eventuell einen Paketmanager, beispielsweise RVM oder Homebrew zur Verwaltung Deiner Ruby-Installation. Weitere Informationen findest Du unter „Fehlerbehebung" in der Jekyll-Dokumentation.

Ein Repository für eine Website erstellen

Wenn Deine Website ein unabhängiges Projekt ist, kannst Du ein neues Repository erstellen, um den Quellcode Deiner Website zu speichern. If your site is associated with an existing project, you can add the source code to that project's repository, in a /docs folder on the default branch or on a different branch. For example, if you're creating a site to publish documentation for a project that's already on GitHub Enterprise Server, you may want to store the source code for the site in the same repository as the project.

Wenn Du eine Website in einem vorhandenen Repository erstellen möchtest, springe zum Abschnitt „Erstellen Deiner Website".

  1. Benutze in der oberen rechten Ecke einer beliebigen Seite das -Dropdownmenü und wähle New Repository (Neues Repository). Dropdownmenü mit der Option, ein neues Repository zu erstellen
  2. Verwende das Dropdownmenü Owner (Inhaber) und wähle das Konto, das das Repository besitzen soll. Dropdownmenü „Owner" (Inhaber)
  3. Gib einen Namen sowie eine optionale Beschreibung für Dein Repository ein. Wenn Du eine Benutzer- oder Organisationswebsite erstellst, muss Dein Repository den Namen <user>.github.io or <organization>.github.io haben. Weitere Informationen findest Du unter „Informationen zu GitHub Pages“. Feld „Create repository" (Erstellen eines Repositorys)
  4. Choose a repository visibility. Weitere Informationen findest Du unter „Über Sichtbarkeit von Repositorys." Optionsfelder um die Repository-Sichtbarkeit auszuwählen

Eine Website erstellen

Bevor Du Deine Website erstellen kannst, musst Du ein Repository für Deine Website auf GitHub Enterprise Server haben. Wenn Du Deine Website nicht in einem vorhandenen Repository erstellst, findest Du weitere Informationen unter „Erstellen eines Repositorys für Deine Website."

Warning: If your site administrator has enabled Public Pages, GitHub Pages sites are publicly available on the internet, even if the repository for the site is private or internal. If you have sensitive data in your site's repository, you may want to remove the data before publishing. For more information, see "Configuring GitHub Pages for your enterprise" and "About repository visibility."

  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-FOLDER 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/
    # Erstellt einen neuen Ordner auf Deinem Computer, der als Git-Repository initialisiert wird
  4. Wechsle in das Verzeichnis des Repositorys.

    $ cd REPOSITORY-NAME
    # Ändert das Arbeitsverzeichnis
  5. Decide which publishing source you want to use. For more information, see "About GitHub Pages."

  6. Navigiere zur Veröffentlichungsquelle für Deine Website. Weitere Informationen zu Veröffentlichungsquellen findest Du unter „Informationen zu GitHub Pages.“ For example, if you chose to publish your site from the docs folder on the default branch, create and change directories to the docs folder.

    $ mkdir docs
    # Erstellt einen neuen Ordner mit dem Namen docs
    $ cd docs

    Wenn Sie Ihre Website aus dem gh-pages-Branch veröffentlichen möchten, erstellen Sie den gh-pages-Branch und checken ihn aus.

    $ git checkout --orphan gh-pages
    # Erstellt einen neuen Branch, ohne Verlauf und Inhalte, mit dem namen gh-pages und wechselt zum gh-pages-Branch
  7. To create a new Jekyll site, use the jekyll new command:

    $ jekyll new .
    # Erstellt eine Jekyll-Website im aktuellen Verzeichnis
  8. Open the Gemfile that Jekyll created.

  9. Add "#" to the beginning of the line that starts with gem "jekyll" to comment out this line.

  10. Add the github-pages gem by editing the line starting with # gem "github-pages". Change this line to:

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

    Replace GITHUB-PAGES-VERSION with the latest supported version of the github-pages gem. You can find this version here: "Dependency versions."

    The correct version Jekyll will be installed as a dependency of the github-pages gem.

  11. Speichere und schließe das Gemfile.

  12. From the command line, run bundle update.

  13. Optionally, make any necessary edits to the _config.yml file. This is required for relative paths when the repository is hosted in a subdirectory. For more information, see "Splitting a subfolder out into a new 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   
    
  14. Teste Deine Website optional lokal. Weitere Informationen findest Du unter „Deine GitHub Pages-Website lokal mit Jekyll testen.“

  15. Add and commit your work.

    git add .
    git commit -m 'Initial GitHub pages site with Jekyll'
  16. Add your GitHub Enterprise Server repository as a remote, replacing HOSTNAME with your enterprise's hostname, USER with the account that owns the repository, and REPOSITORY with the name of the repository.

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

    $ git push -u origin BRANCH
  18. Configure your publishing source. Weitere Informationen findest Du unter „Eine Veröffentlichungsquelle für Deine GitHub Pages-Website konfigurieren.“

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

  20. Klicke unter Deinem Repository-Namen auf Settings (Einstellungen). Schaltfläche „Repository settings" (Repository-Einstellungen)

  21. Um Deine veröffentlichte Website anzuzeigen, klicke unter „GitHub Pages" auf die URL Deiner Website. URL Deiner veröffentlichten Website

    Hinweis: Es kann bis zu 20 Minuten dauern, bis die Änderungen auf Ihrer Website veröffentlicht werden, nachdem Sie die Änderungen zu GitHub Enterprise Server gepusht haben. Wenn Deine Änderungen nach einer Stunde in Deinem Browser nicht angezeigt werden, findest Du weitere Informationen unter „Über Jekyll-Build-Fehler für GitHub Pages-Websites."

Note: If your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source.

Nächste Schritte:

Informationen dazu, wie Sie eine neue Seite oder einen neuen Beitrag zu Ihrer Website hinzufügen, finden Sie 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 zu Deiner GitHub Pages-Website mit Jekyll hinzufügen.“

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Oder, learn how to contribute.