Writing & StyleStyle guide

Keeping Include Media Outside Includes Folders

Keeping Include Media Outside Includes Folders 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

Keep images and other media referenced by Microsoft Learn includes outside the `/Includes` directory, because the Includes directory is excluded from the build; place associated media in a separate `/media` location.

Key details

Core Issueinclude media placement
RegisterMicrosoft Learn technical documentation

Important caveats

Scope Boundary

This file-placement rule is specific to the Microsoft Learn build pipeline. It does not prescribe folder structures for unrelated Markdown systems.

Further guidance

Content

Keep images and other media referenced by Microsoft Learn includes outside the `/Includes` directory, because the Includes directory is excluded from the build; place associated media in a separate `/media` location.

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.

Related guides

Writing & Style

Keeping Separate Media Files for Learn Includes

Keeping Separate Media Files for Learn Includes records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Explore the topic