Markdown-Prozessor für deine GitHub Pages-Website mit Jekyll festlegen

Mit einem Markdown-Prozessor legst du fest, wie Markdown auf deiner GitHub Pages-Website gerendert wird.

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. Weitere Informationen findest du unter GitHub-Pläne.

GitHub Pages verwendet nun GitHub Actions zur Ausführung des Jekyll-Builds. Wenn Sie einen Zweig als Quelle Ihres Builds verwenden, muss GitHub Actions in Ihrem Repository aktiviert sein, wenn Sie den eingebauten Jekyll-Workflow verwenden möchten. Wenn GitHub Actions nicht verfügbar oder deaktiviert ist, können Sie alternativ eine .nojekyll-Datei zum Stamm Ihrer Quellverzweigung hinzufügen, um den Jekyll-Erstellungsprozess zu umgehen und den Inhalt direkt bereitzustellen. Weitere Informationen zur Aktivierung von GitHub Actions finden Sie unter „Verwalten von GitHub Actions-Einstellungen für ein Repository“

Personen mit Schreibberechtigungen für ein Repository können den Markdown-Prozessor für eine GitHub Pages-Website festlegen.

GitHub Pages unterstützt zwei Markdownprozessoren: kramdown und den eigenen Markdownprozessor von GitHub, der zum Rendern von GitHub Flavored Markdown (GFM) in GitHub verwendet wird. Weitere Informationen findest du unter Informationen zum Schreiben und Formatieren bei GitHub.

Du kannst GitHub Flavored Markdown für beide Prozessoren verwenden, wobei jedoch nur der GFM-Prozessor die Ergebnisse exakt wie in GitHub darstellt.

  1. Navigiere in GitHub zum Repository Deiner Website.
  2. Navigiere in deinem Repository zur Datei _config.yml.
  3. Klicke zum Öffnen des Datei-Editors oben rechts in der Dateiansicht auf .

Screenshot einer Datei. In der Kopfzeile ist eine Schaltfläche mit Stiftsymbol dunkelorange umrandet.

Hinweis: Anstatt die Datei mit dem gewöhnlichen Datei-Editor zu bearbeiten und zu committen, kannst du optional den Code-Editor von github.dev verwenden, indem du das Dropdownmenü auswählst und dann auf github.dev klickst. Du kannst das Repository auch klonen und die Datei lokal über GitHub Desktop bearbeiten, indem du auf GitHub Desktop klickst.

Screenshot einer Datei. In der Kopfzeile ist ein nach unten zeigendes Dreieckssymbol dunkelorange umrandet.

1. Suche die Zeile, die mit `markdown:` beginnt, und ändere den Wert in `kramdown` oder `GFM`. Die vollständige Zeile sollte `markdown: kramdown` oder `markdown: GFM` lauten.

  1. Klicke auf Änderungen committen... .

  2. Gib im Feld „Commitnachricht“ eine kurze, aussagekräftige Commitnachricht ein, die die Änderung beschreibt, die Du an der Datei vorgenommen hast. Du kannst den Commit in der Commit-Mitteilung mehr als einem Autor zuordnen. Weitere Informationen findest du unter Einen Commit mit mehreren Autoren erstellen.

  3. Wenn Ihrem Konto in GitHub mehrere E-Mail-Adressen zugeordnet sind, klicken Sie auf das Dropdownmenü für E-Mail-Adressen und wählen Sie die Adresse aus, die als Git-Autor-Adresse für den verwendet werden soll. Nur verifizierte E-Mail-Adressen werden in diesem Dropdownmenü angezeigt. Wenn Sie den Datenschutz für E-Mail-Adressen aktiviert haben, ist die Commitautor-Standardadresse No-reply. Weitere Informationen zur genauen Form der No-reply-E-Mail-Adresse finden Sie unter „E-Mail-Adresse für Commits festlegen“.

    Screenshot eines GitHub-Pull Requests mit einem Dropdownmenü mit Optionen zum Auswählen der Commit-E-Mail-Adresse des Autors. octocat@github.com ist ausgewählt.

  4. Lege unter den Commit-Mitteilungsfeldern fest, ob Du Dein Commit zum aktuellen Branch oder zu einem neuen Branch hinzufügen möchten. Wenn dein aktueller Branch als Standardbranch festgelegt ist, solltest du einen neuen Branch für deinen Commit und dann einen Pull Request erstellen. Weitere Informationen findest du unter Erstellen eines Pull Requests.

    Screenshot eines GitHub-Pull Requests mit einem Optionsfeld zum direkten Commit an den Mainbranch oder zum Erstellen eines neuen Branchs. Der neue Branch ist ausgewählt.

  5. Klicke auf Änderungen committen oder Änderungen vorschlagen.

Weiterführende Themen