Writing & StyleStyle guide

Adding GIF Image Resources in docfx.json

Adding GIF Image Resources in docfx.json 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 supports .jpg and .png images by default; to use another image type such as .gif, add that file pattern as a resource in docfx.json.

Key details

Core IssueGIF image resource configuration
RegisterMicrosoft Learn technical documentation

Important caveats

Scope Boundary

This is a Microsoft Learn/docfx resource configuration requirement, not a general Markdown rule about whether browsers can display GIF files.

Further guidance

Content

Microsoft Learn supports .jpg and .png images by default; to use another image type such as .gif, add that file pattern as a resource in docfx.json.

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

Escaping Underscores in Microsoft Learn Image Alt Text

Escaping Underscores in Microsoft Learn Image Alt Text 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