Informationen zu GitHub Pages und Jekyll

Informationen zu Jekyll

Jekyll ist ein Generator für statische Websites mit integrierter Unterstützung von GitHub Pages und einem vereinfachten Build-Prozess. Jekyll erstellt aus Markdown- und HTML-Dateien eine statische Website und nutzt dabei die von Ihnen ausgewählten Layouts. Jekyll unterstützt Markdown und Liquid, eine Vorlagensprache, die dynamische Inhalte auf Ihrer Website lädt. Weitere Informationen finden Sie auf der Website zu Jekyll.

Jekyll wird von Windows nicht offiziell unterstützt. Weitere Informationen finden Sie unter „Jekyll on Windows“ (Jekyll unter Windows) in der Jekyll-Dokumentation.

Wir empfehlen, Jekyll mit GitHub Pages zu verwenden. Wenn Sie möchten, können Sie aber auch andere Generatoren für statische Websites verwenden oder einen eigenen Build-Prozess lokal oder auf einem anderen Server anpassen. Weitere Informationen finden Sie unter „Informationen zu GitHub Pages“.

Jekyll in der GitHub Pages-Website konfigurieren

Sie können die meisten Jekyll-Einstellungen, z. B. das Design und die Plug-ins Ihrer Website, konfigurieren, indem Sie die Datei _config.yml bearbeiten. Weitere Informationen finden Sie unter „Configuration“ (Konfiguration) in der Jekyll-Dokumentation.

Einige Konfigurationseinstellungen können für GitHub Pages-Websites nicht geändert werden.

lsi: false
safe: true
source: [your repo's top level directory]
incremental: false
highlighter: rouge
gist:
  noscript: false
kramdown:
  math_engine: mathjax
  syntax_highlighter: rouge

Standardmäßig erstellt Jekyll keine Dateien und Ordner, auf die Folgendes zutrifft:

• Sie befinden sich in einem Ordner mit dem Namen /node_modules oder /vendor
• Sie beginnen mit _, . oder #
• Sie enden mit ~
• Sie werden von der exclude-Einstellung in der Konfigurationsdatei ausgeschlossen

Wenn Sie möchten, dass Jekyll solche Dateien verarbeitet, können Sie dies mit der includes-Einstellung in der Konfigurationsdatei festlegen.

Frontmatter

Um Variablen und Metadaten wie Titel und Layout für eine Seite oder einen Beitrag auf Deiner Seite zu setzen, kannst Du YAML-Titelei zuoberst in jeder Markdown- oder HTML-Datei hinzufügen. Weitere Informationen findest Du unter „Titelei" in der Jekyll Dokumentation.

Sie können site.github zu einem Beitrag oder einer Seite hinzufügen, um Repository-Referenz-Metadaten zu Ihrer Website hinzuzufügen. Weitere Informationen finden Sie unter „Using site.github“ (site.github verwenden) in der Jekyll-Metadaten-Dokumentation.

Designs

Du kannst zu Deiner GitHub Pages-Website ein Jekyll-Design hinzufügen, um das Erscheinungsbild Deiner Website anzupassen. Weitere Informationen finden Sie unter „Themes“ (Designs) in der Jekyll-Dokumentation.

You can add a theme to your site manually. For more information, see "Supported themes" on the GitHub Pages site and "Adding a theme to your GitHub Pages site using Jekyll."

Sie können alle Standardeinstellungen Ihres Designs überschreiben, indem Sie die Dateien des Designs bearbeiten. Weitere Informationen finden Sie in der Dokumentation zu Ihrem Design und unter „Overriding your theme's defaults“ (Standardeinstellungen Ihres Designs überschreiben) in der Jekyll-Dokumentation.

Plug-ins

Sie können Jekyll-Plug-ins herunterladen oder erstellen, um die Funktionalität von Jekyll für Ihre Website zu erweitern. Mit dem Plugin jemoji können Sie beispielsweise GitHub-Emojis auf allen Seiten Ihrer Website genauso verwenden wie auf GitHub. Weitere Informationen finden Sie unter „Plugins“ (Plug-ins) in der Jekyll-Dokumentation.

GitHub Pages verwendet Plug-ins, die standardmäßig aktiviert sind und nicht deaktiviert werden können:

• jekyll-coffeescript
• jekyll-default-layout
• jekyll-gist
• jekyll-github-metadata
• jekyll-optional-front-matter
• jekyll-paginate
• jekyll-readme-index
• jekyll-titles-from-headings
• jekyll-relative-links

Sie können zusätzliche Plug-ins aktivieren, indem Sie die Gem des Plug-ins zur plugins-Einstellung in der Datei _config.yml hinzufügen. Weitere Informationen finden Sie unter „Configuration“ (Konfiguration) in der Jekyll-Dokumentation. Eine Liste der unterstützten Plug-ins finden Sie unter „Abhängigkeitsversionen auf der GitHub Pages-Website.

Informationen zur Verwendung eines bestimmten Plug-ins finden Sie in der dazugehörigen Dokumentation.

GitHub Pages kann keine Websites mit nicht unterstützten Plug-ins erstellen. Wenn Sie nicht unterstützte Plug-ins verwenden möchten, müssen Sie Ihre Website lokal erstellen und die statischen Dateien der Website anschließend zu GitHub Enterprise pushen.

Syntaxmarkierung

Damit Ihre Website leichter lesbar ist, werden Code-Ausschnitte auf GitHub Pages-Websites ebenso markiert wie auf GitHub Enterprise. Weitere Informationen zur Syntaxmarkierung auf GitHub Enterprise finden Sie unter „Codeblöcke erstellen und markieren“.

Standardmäßig werden Codeblöcke auf Ihrer Website von Jekyll markiert. Jekyll verwendet den Markierer Rouge, der mit Pygments kompatibel ist. Wenn Sie in Ihrer _config.yml-Datei Pygments festlegen, wird stattdessen Rouge verwendet. Jekyll kann keinen anderen Syntaxmarkierer verwenden. Wenn Sie anderen Syntaxmarkierer in der _config.yml-Datei angeben, wird eine Seiten-Build-Warnung angezeigt. Weitere Informationen finden Sie unter „Informationen zu Jekyll-Build-Fehler für GitHub Pages-Websites“.

Wenn Sie einen anderen Markierer verwenden möchten, z. B. highlight.js, müssen Sie die Jekyll-Syntaxmarkierung deaktivieren, indem Sie die _config.yml-Datei Ihres Projekts ändern.

kramdown:
  syntax_highlighter_opts:
    disable : true

Wenn Ihr Design kein CSS für die Syntaxmarkierung enthält, können Sie das CSS von GitHub zur Syntaxmarkierung erzeugen und zur Datei style.css des Projekts hinzufügen.

$ rougify style github > style.css

Website lokal erstellen

Änderungen an Deiner Website werden automatisch veröffentlicht, wenn die Änderungen in der Veröffentlichungsquelle Deiner Website zusammengeführt werden. Wenn Du zuerst eine Vorschau Ihrer Änderungen sehen möchtest, kannst Du die Änderungen lokal vornehmen statt auf GitHub Enterprise. Dann teste Deine Website lokal. Weitere Informationen findest Du unter „GitHub Pages-Website lokal mit Jekyll testen“.