v2.64.0

[yufeih]

C# documentation comment link enhancements

This release improves link generation for C# documentation comment in a couple of areas:

• Links to base class libraries are generated automatically without using the xref service or extra config. This is done by calculating the references to APIs hosted on https://learn.microsoft.com/dotnet/api using an URL pattern offline.
• View source is now available for assemblies as input if
  • The assembly enables SourceLink
  • A PDB file exist next to the assembly file.
• Links to types in dependency assemblies produces URLs pointing to the API source code location if:
  • The dependency assembly enables SourceLink
  • A PDB file exist next to the assembly file.
• <see langword=""> now properly resolves to URLs pointing to https://learn.microsoft.com.

MemberPage as a first class feature

The memberpage plugin is now replaced by a first-class feature using the experimental { "memberLayout": "SeparatePages" } config. See this example on how to enable the behavior in docfx.json.

NOTE: This new feature has been manually tested for the default templates, the modern template and the statictoc template, but there might be glitches in some edge cases.

Sunset DFM markdown engine

The MarkdownLite and DFM markdown engine is removed from docfx in this release. DFM users are encouraged to update to markdig for a commonmark compliant markdown parser, a rich markdown extension eco-system and better performance.

What's Changed

💥 Breaking Changes

• BREAKING CHANGE: drop dfm markdown engine by @yufeih in BREAKING CHANGE: drop dfm markdown engine #8537
• chore: drop preserveRawInlineComment by @yufeih in BREAKING CHANGE: drop preserveRawInlineComment #8557
• chore: remove sees from YAML output by @yufeih in chore: remove sees from YAML output #8559
• chore: drop useCompatibilityFileName by @yufeih in chore: drop useCompatibilityFileName #8568

🎉 New Features

• feat: compute mslearn symbol URL by @yufeih in feat: compute mslearn symbol URL #8546
• feat: view source for assemblies using sourcelink by @yufeih in feat: view source for assemblies using sourcelink #8548
• feat: resolve langword to URLs by @yufeih in feat: resolve langword to URLs #8550
• feat: add allowCompilationErrors option by @yufeih in feat: add allowCompilationErrors option #8554
• feat: memberpage plugin -> memberLayout.SeparatePages by @yufeih in feat: memberpage plugin -> memberLayout.SeparatePages #8569

🐞 Bug Fixes

• fix: mslearn link not resolved in generic type parameter by @yufeih in fix: mslearn link not resolved in generic type parameter #8549
• fix: ' in seealso by @yufeih in fix: ' in seealso #8551
• fix: NRE on duplicated params by @yufeih in fix: NRE on duplicated params #8552
• fix: add margin to list terms by @yufeih in fix: add margin to list terms #8555
• fix: undefined lunrIndex by @yufeih in fix: undefined lunrIndex #8556
• fix: dark theme flash on page refresh by @yufeih in fix: dark theme flash on page refresh #8573

📄 Documentation

• Update index.md workflow sample by @mtirionMSFT in Update index.md workflow sample #8570

Full Changelog: v2.63.1...v2.64.0

---

This discussion was created from the release v2.64.0.