🚀 Release Notes

🌟 New Features

• 🧩 Updated to Roslyn 4.13.0 and added .NET 10 nightly build support. (#10577, #10561)

🐞 Bug Fixes

• ✅ Include [Experimental] attribute support by default. (#10566)
• ✅ Include global type metadata for all output formats. (#10611)
• ✅ Skip non-managed assemblies to prevent runtime errors. (#10692)
• ✅ Fix TOC grouping regression introduced by earlier refactor. (#10700)
• ✅ Fix Bicep.js import error on the samples site. (#10738)
• ✅ Handle IOException gracefully when file access conflicts occur. (#10786)
• ✅ Fix PDF generation failure when navigating within the same page or hash fragment. (#10768)
• ✅ Use textContent to correctly render header titles. (#10790)
• ✅ Fixed nightly build CI and dependency updates. (#10679, #10694)
• ✅ Added event handling for AnalyzerLoadFailed to improve debugging. (#10617)

⚡ Performance Improvements

• ⚙️ Use cached MarkdownPipeline instance to reduce re-initialization overhead. (#10568)
• ⚙️ Reuse YamlDeserializer instance for better memory efficiency. (#10567)
• ⚙️ Migrated test assertions to AwesomeAssertions for faster, cleaner test runs. (#10563)
• ⚙️ Improved analyzer diagnostics and reduced noisy suggestions. (#10578)

📘 Documentation Updates

• 📄 Minor doc fix and .slnx inclusion. (#10610)
• 📄 Fixed config reference documentation. (#10683)
• 📄 Corrected PlantUML class diagram link. (#10638)
• 📄 Updated "Tabs with ***" section formatting. (#10699)
• 📄 Fixed minor spelling errors. (#10723)
• 📄 Updated Bicep sample to use official Highlight.js syntax. (#10715)
• 📄 Added DeepWiki badge and improved emoji font embedding in PDF generation. (#10680, #10678)
• 📄 Inputs in navigation and TOC search now auto-focus when icons are clicked. (#10754)

🙌 Contributors

Thanks to our awesome contributors for this release:
@filzrev , @Lombra , @frarees , @ettfemnio , @Lulalaby , @mgarstenauer , @anthony-c-martin , @clicktodev , @Copilot, and everyone who helped improve this release 💙

Contributors

• @frarees
• @ettfemnio
• @Lombra
• @mgarstenauer
• @Lulalaby
• @clicktodev
• @anthony-c-martin
• @filzrev

What's Changed

🎉 New Features

• feat: Add noRestore option to docfx metadata command by @filzrev in #10428
• feat: Allow extensionless URL HTML file access by @filzrev in #10436
• feat: Add .slnx solution format metadata generation support by @filzrev in #10540
• feat!: search improvements by @frarees in #10113

🐞 Bug Fixes

• fix: Add remarks content to enum members by @filzrev in #10434
• fix: Modify isCoverPage check conditions by @filzrev in #10453
• fix: Use provided references for search of dependencies in AssemblyCompilations by @Herrmel in #10491
• fix: Doc comment <code> block is not rendered correctly by @filzrev in #10390

🚀 Performance Improvements

• perf: Optimize pdf generation performance by reducing file I/O by @filzrev in #10461
• perf: Reduce exceptions of APIPage deserialization by @filzrev in #10548

New Contributors

• @Herrmel made their first contribution in #10491

Full Changelog: 2.78.2...v2.78.3

Contributors

• @frarees
• @Herrmel
• @filzrev

What's Changed

🎉 New Features

• feat: Reformat YouTube videos to the embeded URL by @hultqvist in #10372

🐞 Bug Fixes

• fix: Fix Node.js prerequisite issues by @filzrev in #10406
• fix: System.Reflection.Metadata.Document.Name can throw BadImageForma... by @RobJessop in #10410
• fix: Bootstrap variable override problem by @filzrev in #10412
• fix: Skip header/footer rendering for cover page by @filzrev in #10416

📄 Documentation

• docs: Add how to use docfx nightly version by @filzrev in #10394

💪 Other Changes

• chore: Add published package tests to nightly build workflow by @filzrev in #10403
• chore: Update Dockerfile by @filzrev in #10407

New Contributors

• @hultqvist made their first contribution in #10372

Full Changelog: 2.78.1...2.78.2

Contributors

• @hultqvist
• @RobJessop
• @filzrev

What's Changed

🐞 Bug Fixes

• fix: Place .playwright directory under bin directory by @filzrev in #10399
• fix: Use PlantUML Online Server as default configs by @filzrev in #10395

Full Changelog: v2.78.0...2.78.1

Contributors

• @filzrev

This release introduces support for .NET 9 and drops support for .NET 6, with a wide range of bug fixes and improvements.
A big thank you to @filzrev for continuous improvements to DocFX and to @SimonCropp for the substantial contributions to code quality in this project!

What's Changed

💥 Breaking Changes

• feat: Add .NET 9 support (and drop .NET 6 support) by @filzrev in #10239
• feat: Change generated HTML encoding to UTF-8N (without BOM) by @filzrev in #10069

🎉 New Features

• feat: Remove Node.js runtime dependencies from docfx tools by @filzrev in #10066
• feat: UseClrTypeNames: new option to indicate that the output must use the CLR type names instead of the language specific aliases by @Patrick8639 in #10072
• feat: pdfHeaderTemplate/pdfFooterTemplate supports value as file path by @yufeih in #10099
• feat: expose type through the toc by @frarees in #10090
• feat: Add CancellationToken support for RunBuild.Exec by @filzrev in #10185
• feat: add AllowUnsafeBlocks supports for source code based metadata generation by @filzrev in #10175
• feat: Add System.Text.Json serialization/deserialization supports by @filzrev in #10217

🐞 Bug Fixes

• fix: PDF Header/Footer pages size by @filzrev in #10100
• fix: missing delegate group name by @frarees in #10114
• fix: prevent the first navbar element from being set as active unnecessarily in the modern template by @KubaZ2 in #10204
• fix: NullReferenceException thrown when running tests in parallel by @filzrev in #10181
• fix: change link as plaintext if API is excluded by @filzrev in #10300
• fix: suppress assembly load warning for wpf 8.0 project by @yufeih in #10303

📄 Documentation

• docs: update ConceptualDocumentProcessor reference by @emmanuel-ferdman in #10237
• docs: Update Version in "Use the NuGet Library" by @RiPont in #10233
• docs: Add Publish from Azure DevOps by @kale-swapnil in #10213
• docs: fixed article a/an in config.md by @MorkovnySok in #10272
• docs: Add node.js as prerequisite by @filzrev in #10299
• docs: Document the xref nameWithType option by @AArnott in #10368

New Contributors

• @frarees made their first contribution in #10090
• @KubaZ2 made their first contribution in #10204
• @emmanuel-ferdman made their first contribution in #10237
• @RiPont made their first contribution in #10233
• @kale-swapnil made their first contribution in #10213
• @MorkovnySok made their first contribution in #10272
• @AArnott made their first contribution in #10368

Full Changelog: v2.77.0...v2.78.0

Contributors

• @AArnott
• @SimonCropp
• @frarees
• @yufeih
• @RiPont
• @Patrick8639
• @MorkovnySok
• @emmanuel-ferdman
• @kale-swapnil
• @KubaZ2
• @filzrev

What's Changed

💥 Breaking Changes

• chore: Drop .NET 7 SDK supports by @filzrev in #9911

🎉 New Features

• feat: Enable PreferCSSPageSize option for PDF generation by @filzrev in #9850
• feat: Add docfx JSON Schema files and related tests by @filzrev in #9852
• feat: Add toc.json transform logics using toc.extension.js by @filzrev in #9953
• feat: Better error when link not found by @Patrick8639 in #9957
• feat: Add categoryLayout option for metadata generation by @filzrev in #9965
• feat: Permits to specify the placement of overwrites by @Patrick8639 in #9937
• feat: Support private symbols by @Patrick8639 in #9972
• feat: Add support for gzipped xrefmap that stored as local file by @filzrev in #9966
• feat: Enable view transitions feature by @filzrev in #9909

🐞 Bug Fixes

• fix: PDF Producer document information by @filzrev in #9851
• fix: Xrefmap baseUrl problem reported at #9866 by @filzrev in #9869
• fix: Xref links are not resolved on docs site by @filzrev in #9880
• fix: Change same URL check logic to case invariant by @filzrev in #9883
• fix: Improve unresolved xref messages by @filzrev in #9884
• fix: Fix nightly build errors by @filzrev in #9913
• fix: TOC filter value is not shared between pages by @filzrev in #9912
• fix: Build problems when running .NET 6 version of docfx on some environment by @filzrev in #9922
• fix: docfx metadata command throw ArgumentException when referencing empty namespace by doc comment by @filzrev in #10023
• fix: serve url link by @WeihanLi in #10035

🚀 Performance Improvements

• perf: Change serializer for XrefMap from NewtonsoftJson to System.Text.Json by @filzrev in #9872
• perf: Remove some enum boxing in GlobMatcher by @lahma in #10051
• perf: Optimize CountWordInText by @lahma in #10050

🔧 Engineering

• chore: Skip unstable SVG content check that returned from PlantUML Online Server by @filzrev in #9858
• deps: Update Spectre.Console package versions by @filzrev in #9894
• chore: fix NU5129 warning on dotnet pack command by @filzrev in #9942
• chore: Add PolySharp libarary to use latest C# syntax by @filzrev in #9960
• chore: Add snapshot update workflow by @filzrev in #9969
• chore: Remove unused workflow settings by @filzrev in #10030

📄 Documentation

• docs: Fix typo by @carlos-regis in #9871
• docs: Fix URL in markdown and match to html example by @si618 in #9881
• docs: Fix documentation site build warnings by @filzrev in #9895
• docs: Fix missing docfx.json config docs by @filzrev in #9935
• docs: Fix Docfx.App nuget package usage document by @filzrev in #9994
• docs: Fix plugin related docs and logs by @filzrev in #10029

New Contributors

• @carlos-regis made their first contribution in #9871
• @si618 made their first contribution in #9881
• @Patrick8639 made their first contribution in #9957

Full Changelog: v2.76.0...v2.77.0

Contributors

• @lahma
• @si618
• @WeihanLi
• @Patrick8639
• @filzrev
• @carlos-regis

What's Changed

🎉 New Features

• feat: Add DefineConstants supports for source file based build by @filzrev in #9707
• feat: Add additional layout options to modern template by @filzrev in #9737
• feat: Add pdfPrintBackground setting by @cjlotz in #9742
• feat: Update roslyn packages by @filzrev in #9753
• feat: Publish nightly pre-release packages by @yufeih in #9788
• feat: Add DLL references support for file-based API metadata generation by @filzrev in #9825
• feat: Support DOCFX_SOURCE_REPOSITORY_URL by @filzrev in #9759
• feat: Add feature to configure markdig extension by docfx.json configs. by @filzrev in #9820
• feat: Support for all emphasis supported by MarkDig by @EMaderbacher in #9762

🐞 Bug Fixes

• fix: docfx download command behaviors by @filzrev in #9721
• fix: Resolved .NET SDK version problem on source-based API metadata generation by @filzrev in #9713
• fix: Don't overwrite _disabledToc when metadata is explicitly defined by @filzrev in #9741
• fix: Outputted PDF displays garbled characters when name contains non-ASCII chars by @filzrev in #9769
• fix: Move script tags into head in modern template by @fuzzykiller in #9768
• fix: Broken examples problems when using inheritdoc tag by @filzrev in #9754
• fix: NullReferenceException occurred when both include and exclude are null by @filzrev in #9786
• fix: Change JsonSchema EvaluationOptions instance to shared object by @filzrev in #9807
• fix: Bug fix Invalid documentation on type parameter #9755 by @soniyaprasad77 in #9806

🚀 Performance Improvements

• perf: Optimize xrefmap.json file deserialization performance by @filzrev in #9824

🔧 Engineering

• chore: percy snapshot by @yufeih in #9747
• chore: Add detailed error message for specific exceptions by @filzrev in #9746
• chore: update pdfpig nuget package version by @filzrev in #9803

📄 Documentation

• docs: Split docfx CLI reference docs based on commands by @filzrev in #9708
• docs: Update markdown documentation regarding MarkDig extension by @tbolon in #9810
• docs: Update docfx.json config reference document by @filzrev in #9813
• docs: Correct docfx template page title by @peitschie in #9812
• docs: Add a warning about relative path resolution. by @voroninp in #9828

New Contributors

• @EMaderbacher made their first contribution in #9762
• @fuzzykiller made their first contribution in #9768
• @soniyaprasad77 made their first contribution in #9806
• @tbolon made their first contribution in #9810
• @peitschie made their first contribution in #9812
• @voroninp made their first contribution in #9828

Full Changelog: v2.75.3...v2.76.0

Contributors

• @tbolon
• @yufeih
• @btzdnl
• @peitschie
• @cjlotz
• @voroninp
• @EMaderbacher
• @soniyadotp
• @filzrev

What's Changed

🐞 Bug Fixes

• fix: Toc warnings when toc item with TopicUid but name is not specified by @filzrev in #9665
• fix: Warnings that occurs when bookmark link contains non-ASCII chars by @filzrev in #9660
• fix: Add StackTrace logs for Javascript error by @filzrev in #9694
• fix: InvalidInputFile error occurs if file contains URI escaped charactors by @filzrev in #9700
• fix: Add fail-fast logics when --serve option enabled & port is already used by @filzrev in #9690
• fix: filterconfig exclude rule is not works as documented by @filzrev in #9666

🔧 Engineering

• build(deps): bump YamlDotNet from 15.1.0 to 15.1.1 dependencies .NET by @filzrev in #9689
• chore: update NuGet package dependencies (Microsoft.NET.Test.Sdk,Microsoft.Build.Locator) by @filzrev in #9693
• chore: Update public API snapshot & disable AutoVerify on CI build by @filzrev in #9692
• chore: Update node.js version by @filzrev in #9701
• chore: Update Microsoft.Build package version by @filzrev in #9698

Full Changelog: v2.75.2...v2.75.3

Contributors

• @filzrev

What's Changed

🐞 Bug Fixes

• fix: mref mustach template description leak by @yufeih in #9632
• fix: When disableDefaultFilter is enabled. `filterConfig.yml' is not loaded. by @filzrev in #9638
• fix: new line in mref title by @yufeih in #9633
• fix: Corrected class name in inheritedMembers block by @BattlefieldDuck in #9648
• fix: ApiPage is not generated when multiple namespaces defined across projects by @filzrev in #9650
• fix: Add warnings for UnresolvedAnalyzerReference by @filzrev in #9623

🚀 Performance Improvements

• pref: Optimize xrefmap download performance by @filzrev in #9637

🔧 Engineering

• chore: Update Verify.Xunit dependencies by @filzrev in #9624
• chore: Update YamlDotNet version by @filzrev in #9654

📄 Documentation

• Markdig extensions configuration/support documentation by @cjlotz in #9615

New Contributors

• @BattlefieldDuck made their first contribution in #9648

Full Changelog: v2.75.1...v2.75.2

Contributors

• @yufeih
• @cjlotz
• @BattlefieldDuck
• @filzrev

What's Changed

🎉 New Features

• feat: Include API summary in tag by @yufeih in #9611

🐞 Bug Fixes

• fix: remove PDF missing TOC warning by @yufeih in #9610

📄 Documentation

• Updated docs to include PlantUML extension by @cjlotz in #9607

Full Changelog: v2.75.0...v2.75.1

Contributors

• @yufeih
• @cjlotz