文章ドキュメントを含むコミットとプルリクエストには、そのドキュメントをソースとレンダリング済みのビューで表示する機能があります。
ソースビューでは入力された生テキストが表示されますが、レンダリング済みビューでは GitHub Enterprise でレンダリングされた様子を見ることができます。 たとえば、 Markdown での **bold** がレンダリング済みビューで bold と表示される、という違いがあります。
文章のレンダリングがサポートされるのは、github/markup によってサポートされるレンダリング済みドキュメントです。
- Markdown
- AsciiDoc
- Textile
- ReStructuredText
- Rdoc
- Org
- Creole
- MediaWiki
- Pod
をクリックすると、コミットの一環としてドキュメントに行った変更を表示できます。
属性変更を可視化する
読者に見せる文字部分とは異なり、属性への変更は、レンダリングされたドキュメントでは見えなくなります。Github ではそれをツールチップで示します。 たとえば、リンク URL が、あるウェブサイトから別のものに変更された場合、ツールチップで次のように示されます:
変更についてのコメントを入力する
コミットコメントは、ソースビュー内で行ごとにのみ追加できます。
ヘッダにリンクする
他のレンダリング済み文章ドキュメントと同様、ドキュメントのヘッダにマウスオーバーすると、リンクアイコンが作成されます。 レンダリング済み文章の diff の読者を特定のセクションにリンクできます。
複雑な diff を表示する
プルリクエストの中には、大きくて複雑なドキュメントでの多数の変更を含むものがあります。 変更の分析に時間がかかる場合、GitHub Enterprise では必ずしも変更のレンダリング済みビューが生成できるとは限らず、レンダリング済みボタンをクリックすると次のようなメッセージが表示されます:
その場合でもソースビューは変更の分析やコメント入力に使用できます。
HTML 要素を表示する
HTML ドキュメントへのコミットのレンダリング済みビューは、直接にはサポートしていません。 形式の中には、Markdown のように、任意の HTML をドキュメントに埋め込むことができるものがあります。 そうしたドキュメントが GitHub Enterpriseで表示される際、埋め込まれた HTML はプレビューで表示されますが、表示できないもの (埋め込み YouTube 動画など) もあります。
通常、埋め込み HTML を含むドキュメントへの変更のレンダリング済みビューでは、GitHub Enterprise のドキュメントのビューでサポートされている要素への変更を表示します。 埋め込み HTML を含むドキュメントへの変更のレビューは、完全を期して、常にレンダリング済みとソースの両方のビューで行う必要があります。