Festlegen eines Markdown-Prozessors für Ihre GitHub Pages-Website mithilfe von Jekyll

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.

Hinweis

Das Gem github-pages wird zwar für einige Workflows weiterhin unterstützt, allerdings ist GitHub Actions jetzt der empfohlene Ansatz für die Bereitstellung und Automatisierung von GitHub Pages-Websites.

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 finden Sie unter Informationen zum Schreiben und Formatieren auf GitHub.

Du kannst GitHub Flavored Markdown mit einem beliebigen Prozessor verwenden.

  1. Navigiere auf 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.

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

  5. Klicke auf Änderungen committen.

  6. Gib im Feld „Commitnachricht“ eine kurze, aussagekräftige Commitnachricht ein, die die Änderung beschreibt, die Du an der Datei vorgenommen hast. Du kannst einem Commit in der Commit-Nachricht mehr als einen Autor zuweisen. Weitere Informationen finden Sie unter Erstellen eines Commits mit mehreren Autoren oder im Auftrag einer Organisation.

  7. 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 der Standardbranch ist, solltest du auswählen, einen neuen Branch für deinen Commit zu erstellen und dann einen Pull Request zu erstellen. Weitere Informationen finden Sie 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 Zweig wurde ausgewählt.

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

Weiterführende Lektüre