GitHub Pages-Website mit Jekyll erstellen

Inhalt dieses Artikels

• Voraussetzungen
• Ein Repository für eine Website erstellen
• Eine Website erstellen
• Nächste Schritte:

Personen mit Administratorberechtigungen für ein Repository können mit Jekyll eine GitHub Pages-Website erstellen.

Voraussetzungen

Bevor Sie mit Jekyll eine GitHub Pages-Website erstellen können, müssen Sie Jekyll und Git installieren. Weitere Informationen finden Sie 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. To install Bundler:

1. Install Ruby. For more information, see "Installing Ruby" in the Ruby documentation.
2. Installieren Sie Bundler. For more information, see "Bundler."

Ein Repository für eine Website erstellen

If your site is an independent project, you can create a new repository to store your site's source code. If your site is associated with an existing project, you can add the source code for your site to a gh-pages branch or a docs folder on the master branch in that project's repository. For example, if you're creating a site to publish documentation for a project that's already on GitHub Enterprise, you may want to store the source code for the site in the same repository as the project.

If you want to create a site in an existing repository, skip to the "Creating your site" section.

1. In the upper-right corner of any page, use the drop-down menu, and select New repository.

   

2. Use the Owner drop-down menu, and select the account you want to own the repository.

   

3. Geben Sie einen Namen für Ihr Repository sowie optional eine Beschreibung ein. If you're creating a user or organization site, your repository must be named <user>.github.io or <organization>.github.io. Weitere Informationen finden Sie unter „Informationen zu GitHub Pages“.

   

4. Choose to make the repository either public or private. Public repositories are visible to everyone using Ihre GitHub Enterprise Server-Instanz, while private repositories are only accessible to you, and people you share them with. Weitere Informationen finden Sie unter „Sichtbarkeit eines Repositorys festlegen“.

   

Eine Website erstellen

Before you can create your site, you must have a repository for your site on GitHub Enterprise. If you're not creating your site in an existing repository, see "Creating a repository for your site."

1. Open TerminalTerminalGit Bash.

2. Wenn Sie noch keine lokale Kopie Ihres Repositorys besitzen, navigieren Sie zu dem Speicherort, an dem Sie die Quelldateien Ihrer Website speichern möchten, und ersetzen dabei PARENT-FOLDER durch den Ordner, der den Ordner für Ihr Repository enthalten soll.

   $ cd PARENT-FOLDER

3. Wenn Sie dies noch nicht getan haben, initialisieren Sie ein lokales Git-Repository, und ersetzen dabei REPOSITORY-NAME durch den Namen Ihres Repositorys.

   $ git init REPOSITORY-NAME
   > Initialized empty Git repository in /Users/octocat/my-site/.git/
   # Erstellt einen neuen Ordner auf Ihrem Computer, der als Git-Repository initialisiert wird

4. Wechseln Sie in das Verzeichnis des Repositorys.

   $ cd REPOSITORY-NAME
   # Ändert das Arbeitsverzeichnis

5. If you're creating a project site, decide which publishing source you want to use. If you're creating a user or organization site, you must store your site's source code on the master branch. For more information, see "About GitHub Pages."

6. Navigate to the publishing source for your site. Weitere Informationen zu Veröffentlichungsquellen finden Sie unter „Informationen zu GitHub Pages“.

   Wenn Sie z. B. Ihre Website aus dem Ordner docs auf dem master-Branch veröffentlichen möchten, erstellen Sie den Ordner docs und wechseln in dieses Verzeichnis.

   $ 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. Um eine neue Jekyll-Website zu erstellen, führen Sie den Befehl jekyll new aus. Ersetzen Sie dabei VERSION durch die aktuelle Abhängigkeitsversion für Jekyll. Weitere Informationen finden Sie unter „Abhängigkeitsversionen“ auf der GitHub Pages-Website.

   • Wenn Sie Bundler installiert haben:

     $ bundle exec jekyll VERSION new .
     # Erstellt eine Jekyll-Website im aktuellen Verzeichnis

   • Wenn Sie Bundler nicht installiert haben:

     $ jekyll VERSION new .
     # Erstellt eine Jekyll-Website im aktuellen Verzeichnis

8. Öffnen Sie die erstellte Gemfile, und befolgen Sie die Anweisungen in den Gemfile-Kommentaren, um GitHub Pages zu verwenden.

   

9. Aktualisieren Sie die Zeile gem "github-pages" so, dass sie wie folgt aussieht. Ersetzen Sie dabei VERSION durch die aktuelle Abhängigkeitsversion für github-pages. Weitere Informationen finden Sie unter „Abhängigkeitsversionen“ auf der GitHub Pages-Website.

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

10. Speichern und schließen Sie die Gemfile.

11. Testen Sie Ihre Website optional lokal. Weitere Informationen finden Sie unter „GitHub Pages-Website lokal mit Jekyll testen“.

12. Fügen Sie Ihr GitHub Enterprise-Repository als Remote-Repository hinzu. Ersetzen Sie dabei HOSTNAME durch den Hostnamen Ihrer Appliance, USER durch das Konto, das das Repository besitzt, und REPOSITORY durch den Namen des Repositorys.

    $ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
    

13. Pushen Sie das Repository zu GitHub Enterprise, und ersetzen Sie dabei BRANCH durch den Namen des Branches, auf dem Sie gerade arbeiten.

    $ git push -u origin BRANCH

14. If you're using a non-default publishing source for a project site, configure your publishing source. Weitere Informationen finden Sie unter „Eine Veröffentlichungsquelle für Ihre GitHub Pages-Website konfigurieren“.

15. On GitHub Enterprise, navigate to your site's repository.

16. Under your repository name, click Settings.

    

17. To see your published site, under "GitHub Pages", click your site's URL.

    

    Hinweis: Es kann bis zu 20 Minuten dauern, bis die Änderungen auf Ihrer Website veröffentlicht werden, nachdem Sie die Änderungen zu GitHub Enterprise gepusht haben. If your don't see your changes reflected in your browser after an hour, see "About Jekyll build errors for GitHub Pages sites."

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

You can add a Jekyll theme to your GitHub Pages site to customize the look and feel of your site. Weitere Informationen finden Sie unter „Ein Design zu Ihrer GitHub Pages-Website mit Jekyll hinzufügen“.