Unterschiede in Dokumenten mit Fließtext rendern

Commits und Pull Requests an Fließtextdokumenten unterstützen die Darstellung dieser Dokumente im Quell- und im gerenderten Format.

In der Quellansicht wird der eingegebene Rohtext angezeigt. In der gerenderten Ansicht wird der Text dagegen so angezeigt, wie er gerendert auf GitHub aussehen würde. Beispielsweise wird fett ausgezeichneter Text in der Quellansicht in Markdown **fett** dargestellt, in der gerenderten Ansicht dagegen als fett.

Das Rendering von Fließtext wird für gerenderte Dokumente unterstützt, die von github/markup unterstützt werden:

  • Markdown
  • AsciiDoc
  • Textile
  • ReStructured Text
  • Rdoc
  • Org
  • Creole
  • MediaWiki
  • Pod

Papiersymbol zum Anzeigen gerenderter Dokumente mit Fließtext

Zum Anzeigen der im Zuge eines Commits vorgenommenen Änderungen an einem Dokument klicke auf das Symbol .

Änderungen an gerendertem Fließtext

Attributänderungen visualisieren

Zu Attributänderungen, die im Gegensatz zu Worten im gerenderten Dokument nicht sichtbar werden, geben wir gerne einen Toolhinweis. Beispielsweise erhältst Du bei der Änderung einer Link-URL von einer Website zu einer anderen einen Toolhinweis wie diesen:

Attributänderungen an gerendertem Fließtext

Kommentare zu Änderungen

Kommentare zu Commits können nur zu Dateien in der Quellansicht Zeile für Zeile hinzugefügt werden.

Zu Headern verknüpfen

Wie bei anderen gerenderten Dokumenten mit Fließtext wird ein Linksymbol erstellt, sobald Du den Mauszeiger über einen Dokumentheader bewegst. Du kannst die Leser Deines gerenderten Fließtextes über Links zu bestimmten Abschnitten leiten.

Komplexe Unterschiede anzeigen

Einige Pull Requests umfassen sehr viele Änderungen an großen und komplexen Dokumenten. When the changes take too long to analyze, GitHub can't always produce a rendered view of the changes. If this happens, you'll see an error message when you click the rendered button.

Message when view can't be rendered

Jedoch kannst Du die Änderungen auch in der Quellansicht analysieren und kommentieren.

HTML-Elemente anzeigen

Gerenderte Ansichten der Commits an HTML-Dokumenten werden nicht direkt unterstützt. In einigen Formaten wie Markdown kannst Du beliebig HTML im Dokument einbetten. Wenn diese Dokumente in GitHub dargestellt werden, kann ein Teil dieser eingebetteten HTML in einer Vorschau angezeigt werden, manch andere HTML (wie ein eingebettetes YouTube-Video) hingegen nicht.

Im Allgemeinen zeigen gerenderte Ansichten von Dokumentänderungen, die eingebettete HTML enthalten, diejenigen Änderungen an den Elementen an, die in der GitHub-Ansicht des Dokuments unterstützt werden. Aus Gründen der Vollständigkeit sollten Änderungen an Dokumenten, die eingebettete HTML enthalten, immer sowohl in der gerenderten als auch in der Quellansicht überprüft werden.

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.