Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel

rendering-differences-in-prose-documents.md 3.0 KB

You have to be logged in to leave a comment. Sign In
title redirect_from versions
Rendering differences in prose documents [/articles/rendering-differences-in-prose-documents] [{free-pro-team *} {enterprise-server *} {github-ae *}]

Commits and pull requests that include prose documents have the ability to represent those documents with source and rendered views.

The source view shows the raw text that has been typed, while the rendered view shows how that text would look once it's rendered on {% data variables.product.product_name %}. For example, this might be the difference between showing **bold** in Markdown, and bold in the rendered view.

Prose rendering is supported for rendered documents supported by github/markup:

  • Markdown
  • AsciiDoc
  • Textile
  • ReStructuredText
  • Rdoc
  • Org
  • Creole
  • MediaWiki
  • Pod

Paper icon to view rendered prose document

You can click {% octicon "file" aria-label="The paper icon" %} to see the changes made to the document as part of a commit.

Rendered Prose changes

Visualizing attribute changes

We provide a tooltip describing changes to attributes that, unlike words, would not otherwise be visible in the rendered document. For example, if a link URL changes from one website to another, we'd show a tooltip like this:

Rendered Prose attribute changes

Commenting on changes

Commit comments can only be added to files within the source view, on a line-by-line basis.

Linking to headers

As with other rendered prose documents, hovering over a header in your document creates a link icon. You can link readers of your rendered prose diff to specific sections.

Viewing complex diffs

Some pull requests involve a large number of changes with large, complex documents. When the changes take too long to analyze, {% data variables.product.product_name %} 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

You can still use the source view to analyze and comment on changes.

Viewing HTML elements

We don't directly support rendered views of commits to HTML documents. Some formats, such as Markdown, let you embed arbitrary HTML in a document. When these documents are shown on {% data variables.product.product_name %}, some of that embedded HTML can be shown in a preview, while some (like an embedded YouTube video) cannot.

In general, rendered views of changes to a document containing embedded HTML will show changes to the elements that are supported in {% data variables.product.product_name %}'s view of the document. Changes to documents containing embedded HTML should always be reviewed in both the rendered and source views for completeness.

Tip!

Press p or to see the previous file or, n or to see the next file

Comments

Loading...