Writing & StyleStyle guide

Understanding Include Rendering on GitHub

Understanding Include Rendering on GitHub records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Quick answer

Microsoft Learn include directives are not rendered in GitHub’s normal rendered article view because they depend on Learn extensions; the included content is integrated when the article is published.

Key details

Core Issueinclude rendering in GitHub source views
RegisterMicrosoft Learn technical documentation

Important caveats

Scope Boundary

Do not treat a missing include in GitHub’s rendered view as proof that the published Microsoft Learn article will omit it; use the Learn-aware authoring or preview workflow when checking final rendering.

Further guidance

Content

Microsoft Learn include directives are not rendered in GitHub’s normal rendered article view because they depend on Learn extensions; the included content is integrated when the article is published.

Purpose

Keep Microsoft Learn source readable, accessible, reusable, and predictable while following current contributor-platform conventions.

Sources and evidence

Sources are shown with the role they play in this guide. Historical or style-sensitive claims are kept within the evidence boundary described above.

  1. Markdown reference for Microsoft Learn — Contributor guide (opens in a new tab)Microsoft · Current Microsoft Learn contributor reference for Markdown authoring, including headings/navigation, conceptual images and icons, includes, lists/checklists, nonlocalized strings, alerts, comments, tables, and other Learn extensions.

Explore the topic