Writing & StyleStyle guide

Using Site-Relative Links for Microsoft Learn Articles

Using Site-Relative Links for Microsoft Learn Articles 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

Use a Microsoft Learn site-relative URL when the link should be rooted at `https://learn.microsoft.com`; omit the locale and use a leading `/` for an absolute repository-root path rather than `~/`.

Key details

Core Issueusing site-relative links for microsoft learn articles
RegisterMicrosoft Learn technical documentation

Important caveats

Scope Boundary

Microsoft uses URL links outside the current docset or between autogenerated reference and conceptual content. The same guidance says `~/` can produce invalid GitHub source links, so the site/root-relative owner also owns the queued tilde-path prohibition.

Further guidance

Content

Use a Microsoft Learn site-relative URL when the link should be rooted at `https://learn.microsoft.com`; omit the locale and use a leading `/` for an absolute repository-root path rather than `~/`.

Purpose

Keep Microsoft Learn source readable, maintainable, 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. Use links in documentation — Contributor guide (opens in a new tab)Microsoft · Current Microsoft Learn contributor guidance for documentation links, including file-relative and site-relative paths, split-article YML targets, bookmarks, XRef API links, reference-style links, explicit-anchor boundaries, and secure link requirements.

Related guides

Writing & Style

Using File-Relative Links for Microsoft Learn Articles

Using File-Relative Links for Microsoft Learn Articles records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Using Relative Paths for Microsoft Learn Conceptual Images

Using Relative Paths for Microsoft Learn Conceptual Images records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Using XRef Links for Microsoft Learn API References

Using XRef Links for Microsoft Learn API References records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Linking to YML Files for Split Microsoft Learn Articles

Linking to YML Files for Split Microsoft Learn Articles records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Using Reference-Style Links in Microsoft Learn

Using Reference-Style Links in Microsoft Learn records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Using Secure External Links in Microsoft Learn

Using Secure External Links in Microsoft Learn records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Formatting Data Matrix Tables for Microsoft Learn

Formatting Data Matrix Tables for Microsoft Learn records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Writing & Style

Limiting Alerts in Microsoft Learn Articles

Limiting Alerts in Microsoft Learn Articles 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