Bump docfx from 2.70.4 to 2.78.4 #909

dependabot · 2025-12-05T14:04:52Z

Updated docfx from 2.70.4 to 2.78.4.

Release notes

Sourced from docfx's releases.

2.78.4

🚀 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 💙

2.78.3 What's Changed

New Contributors

@Herrmel made their first contribution in fix: Use provided references for search of dependencies in AssemblyCompilations dotnet/docfx#10491

Full Changelog: dotnet/docfx@2.78.2...v2.78.3

2.78.2 What's Changed

🎉 New Features

feat: Reformat YouTube videos to the embeded URL by @hultqvist in feat: Reformat YouTube videos to the embeded URL dotnet/docfx#10372

🐞 Bug Fixes

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

📄 Documentation

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

💪 Other Changes

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

New Contributors

@hultqvist made their first contribution in feat: Reformat YouTube videos to the embeded URL dotnet/docfx#10372

Full Changelog: dotnet/docfx@2.78.1...2.78.2

2.78.1 What's Changed

🐞 Bug Fixes

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

Full Changelog: dotnet/docfx@v2.78.0...2.78.1

2.78.0

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 feat: Add .NET 9 support (and drop .NET 6 support) dotnet/docfx#10239
feat: Change generated HTML encoding to UTF-8N (without BOM) by @filzrev in chore: Change generated HTML encoding to UTF-8N (without BOM) dotnet/docfx#10069

🎉 New Features

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

🐞 Bug Fixes

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

📄 Documentation

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

New Contributors

@frarees made their first contribution in feat: expose type through the toc dotnet/docfx#10090
@KubaZ2 made their first contribution in Prevent the first navbar element from being set as active unnecessarily in the modern template dotnet/docfx#10204
@emmanuel-ferdman made their first contribution in fix: update ConceptualDocumentProcessor reference dotnet/docfx#10237
@RiPont made their first contribution in Update Version in "Use the NuGet Library" dotnet/docfx#10233
@kale-swapnil made their first contribution in Add Publish from Azure DevOps dotnet/docfx#10213
@MorkovnySok made their first contribution in fixed article a/an in config.md dotnet/docfx#10272
@AArnott made their first contribution in Document the xref nameWithType option dotnet/docfx#10368

Full Changelog: dotnet/docfx@v2.77.0...v2.78.0

2.77.0 What's Changed

💥 Breaking Changes

chore: Drop .NET 7 SDK supports by @filzrev in chore: Drop .NET 7 SDK supports dotnet/docfx#9911

🎉 New Features

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

🐞 Bug Fixes

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

🚀 Performance Improvements

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

🔧 Engineering

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

📄 Documentation

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

New Contributors

@carlos-regis made their first contribution in Fix typo dotnet/docfx#9871
@si618 made their first contribution in fix: URL in markdown and match to html example dotnet/docfx#9881
@Patrick8639 made their first contribution in feat(xml): better error when link not found dotnet/docfx#9957

... (truncated)

2.76.0 What's Changed

🎉 New Features

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

🐞 Bug Fixes

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

🚀 Performance Improvements

perf: Optimize xrefmap.json file deserialization performance by @filzrev in perf: Optimize xrefmap.json file deserialization performance dotnet/docfx#9824

🔧 Engineering

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

📄 Documentation

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

New Contributors

@EMaderbacher made their first contribution in feat: Support for all emphasis supported by MarkDig dotnet/docfx#9762
@fuzzykiller made their first contribution in fix: Move script tags into head in modern template dotnet/docfx#9768
@soniyaprasad77 made their first contribution in Bug fix Invalid documentation on type parameter #9755 dotnet/docfx#9806
@tbolon made their first contribution in Update markdown documentation regarding MarkDig extension dotnet/docfx#9810
@peitschie made their first contribution in chore: Correct docfx template page title dotnet/docfx#9812
@voroninp made their first contribution in chore: Add a warning about relative path resolution. dotnet/docfx#9828

Full Changelog: dotnet/docfx@v2.75.3...v2.76.0

2.75.3 What's Changed

🐞 Bug Fixes

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

🔧 Engineering

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

Full Changelog: dotnet/docfx@v2.75.2...v2.75.3

2.75.2 What's Changed

🐞 Bug Fixes

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

🚀 Performance Improvements

pref: Optimize xrefmap download performance by @filzrev in pref: Optimize xrefmap download performance dotnet/docfx#9637

🔧 Engineering

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

📄 Documentation

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

New Contributors

@BattlefieldDuck made their first contribution in fix: Corrected class name in inheritedMembers block dotnet/docfx#9648

Full Changelog: dotnet/docfx@v2.75.1...v2.75.2

2.75.1 What's Changed

🎉 New Features

feat: Include API summary in tag by @yufeih in feat: Include API summary in <meta description> tag dotnet/docfx#9611

🐞 Bug Fixes

fix: remove PDF missing TOC warning by @yufeih in fix: remove PDF missing TOC warning dotnet/docfx#9610

📄 Documentation

Updated docs to include PlantUML extension by @cjlotz in Updated docs to include PlantUML extension dotnet/docfx#9607

Full Changelog: dotnet/docfx@v2.75.0...v2.75.1

2.75.0 What's Changed

💥 Breaking Changes

BREAKING CHAGNE: drop name.vb from toc output by @yufeih in chore: drop name.vb from toc output dotnet/docfx#9530
BREAKING CHANGE: drop pdf on wkhtmltopdf by @yufeih in BREAKING CHANGE: drop pdf on wkhtmltopdf dotnet/docfx#9555

🎉 New Features

feat: Support PlantUml by @cjlotz in Added extensions configuration point and PlantUml support dotnet/docfx#9574
feat: Support solution filter file (.slnf) by @filzrev in feat: Add solution filter file (.slnf) supports dotnet/docfx#9513
feat: Support git submodule by @georghinkel in Support new submodule format using .git file dotnet/docfx#9540
feat: Support PDF header footer template by @yufeih in feat: support PDF header footer template dotnet/docfx#9543
feat: Support description metadata by @yufeih in feat: support description metadata dotnet/docfx#9585

🐞 Bug Fixes

fix: Docset Pdf call terminating early by @dpvreony in FIX: Docset Pdf call terminating early dotnet/docfx#9493
fix: Code copy not shown on collapsed divs by @yufeih in fix: code copy not shown on collapsed divs dotnet/docfx#9531
fix: PDF wait for network idle by @yufeih in fix: PDF wait for network idle dotnet/docfx#9542
fix: Hide the Docfx templates folder from VS project tree by @jwfx in chore: Hide the Docfx templates folder from VS project tree dotnet/docfx#9554
fix: Fix picture image click event handling by @filzrev in chore: Fix picture image click event handling dotnet/docfx#9575
fix: Warn on PDF timeout by @yufeih in fix: warn on PDF timeout dotnet/docfx#9586
fix: Fix japanese search by @Egliss in Fix japanese search dotnet/docfx#9605

🔧 Engineering

Bump docker image to SDK .NET 8 by @JM2K69 in Bump docker image to SDK .NET 8 dotnet/docfx#9501
build: upgrade to Jint 3.0.0-beta-2059 by @lahma in build: upgrade to Jint 3.0.0-beta-2059 dotnet/docfx#9583
build(deps): update nuget dependencies by @filzrev in build(deps): update nuget dependencies dotnet/docfx#9587

📄 Documentation

Update documentation readme by @JM2K69 in Update documentation readme dotnet/docfx#9600

New Contributors

@georghinkel made their first contribution in Support new submodule format using .git file dotnet/docfx#9540
@jwfx made their first contribution in chore: Hide the Docfx templates folder from VS project tree dotnet/docfx#9554
@cjlotz made their first contribution in Added extensions configuration point and PlantUml support dotnet/docfx#9574
@Egliss made their first contribution in Fix japanese search dotnet/docfx#9605

Full Changelog: dotnet/docfx@v2.74.1...v2.75.0

2.74.1

NOTE: If you are using a custom template with a custom toc.html.tmpl file, you may encounter problems building TOC files. Rename toc.html.tmpl to toc.html.primary.tmpl to fix the problem. See dotnet/docfx#9515 for details.

What's Changed

🎉 New Features

feat: support <exclude /> documentation comment by @yufeih in feat: support <exclude /> documentation comment dotnet/docfx#9492
feat: auto-generate TOC name from title by @yufeih in feat: set toc name from title dotnet/docfx#9475 feat: gen TOC name for folder ref or include dotnet/docfx#9481
feat: toggle log severity using rules config by @yufeih in feat: toggle log severity using rules config dotnet/docfx#9460
feat: Add option for including explicit interface implementations by @yufeih in feat: Add option for including explicit interface implementations dotnet/docfx#9471

🐞 Bug Fixes

fix: log message text break at 80 columns by @yufeih in fix: log message text break at 80 columns dotnet/docfx#9464
fix: affix display problem on ios by @yufeih in fix: affix display problem on ios dotnet/docfx#9470
fix: xml indentation issue on external <code> by @yufeih in fix: xml indentation issue on external <code> dotnet/docfx#9465
fix: only allow first h1 to be the title by @yufeih in fix: only allow first h1 to be the title dotnet/docfx#9474
fix: make _tocRel deterministic by @yufeih in fix: make _tocRel deterministic dotnet/docfx#9483
fix: filter compiler generated helpers by @yufeih in fix: filter compiler generated helpers dotnet/docfx#9489
fix: PDB symbol link respect disable git features by @yufeih in fix: PDB symbol link respect disable git features dotnet/docfx#9490
fix: class level seealso leaked to members by @yufeih in fix: class level seealso leaked to members dotnet/docfx#9491

📄 Documentation

docs: fix broken link in filters by @natakazakova in fix broken link in filters dotnet/docfx#9486

Full Changelog: dotnet/docfx@v2.74.0...v2.74.1

2.74.0 What's Changed

💥 Breaking Changes

BREAKING CHANGE: drop log_code from manifest by @yufeih in BREAKING CHANGE: drop log_code from manifest dotnet/docfx#9413
BREAKING CHANGE: drop keepFileLink by @yufeih in BREAKING CHANGE: drop keepFileLink dotnet/docfx#9417
BREAKING CHAGNE: change some internal types from public to internal by @yufeih in feat: change some internal types from public to internal dotnet/docfx#9401

🎉 New Features

feat: Add support for .NET8 by @filzrev in feat: Add support for .NET8 dotnet/docfx#9424
feat: support ExperimentalAttribute for API page by @yufeih in feat: support ExperimentalAttribute for API page dotnet/docfx#9434
feat: add --verbose command line args for verbose logging, drops --repositoryRoot by @yufeih in feat: add --verbose command line args for verbose logging, drops --repositoryRoot dotnet/docfx#9412

🔧 Engineering

chore: Remove NuGet.Frameworks dependency from test projects by @filzrev in chore: Remove NuGet.Frameworks dependency from test projects dotnet/docfx#9276

📄 Documentation

Fix the github actions not working properly in the newest versions of docfx with default settings by @ysftulek in Fix the github actions not working properly in the newest versions of docfx with default settings dotnet/docfx#9430

New Contributors

@ysftulek made their first contribution in Fix the github actions not working properly in the newest versions of docfx with default settings dotnet/docfx#9430

Full Changelog: dotnet/docfx@v2.73.2...v2.74.0

2.73.2 What's Changed

🎉 New Features

feat: Dockerfile by @JM2K69 in feat: Dockerfile dotnet/docfx#9392
feat: support DOCFX_PDF_TIMEOUT by @yufeih in feat: support DOCFX_PDF_TIMEOUT dotnet/docfx#9405
feat: expand TOC on common URL rewrite rules by @yufeih in feat: expand TOC on common URL rewrite rules dotnet/docfx#9408
feat: add start event. by @yufeih in feat: add start event. dotnet/docfx#9418
feat: add showLightbox option by @yufeih in feat: add showLightbox option dotnet/docfx#9416
feat: add TOC order for toc_rel pick order by @yufeih in feat: add TOC order for toc_rel pick order dotnet/docfx#9406

🐞 Bug Fixes

Fix resource configuration property by @MihkelAuv in Fix resource configuration property dotnet/docfx#9394
fix: wrong git path on windows by @yufeih in fix: wrong git path on windows dotnet/docfx#9399
chore: drop phase from logger output by @yufeih in chore: drop phase from logger output dotnet/docfx#9387

🔧 Engineering

test: run snapshot test on windows by @yufeih in test: run snapshot test on windows dotnet/docfx#9397

New Contributors

@JM2K69 made their first contribution in feat: Dockerfile dotnet/docfx#9392

Full Changelog: dotnet/docfx@v2.73.1...v2.73.2

2.73.1 What's Changed

🎉 New Features

feat: update init command by @yufeih in feat: update init command dotnet/docfx#9377

🐞 Bug Fixes

fix: some API page child namespaces 404 by @yufeih in fix: some API page child namespaces 404 dotnet/docfx#9372
build(deps): bump xunit from 2.5.3 to 2.6.1 by @filzrev in build(deps): bump xunit from 2.5.3 to 2.6.1 dotnet/docfx#9378
fix: gracefully handle toc 404 links for PDF by @yufeih in fix: gracefully handle toc 404 links for PDF dotnet/docfx#9380

🚀 Performance Improvements

perf: print page numbers using PdfPig by @yufeih in perf: print page numbers using PdfPig dotnet/docfx#9381

Full Changelog: dotnet/docfx@v2.73.0...v2.73.1

2.73.0 New PDF builder

This release introduces a new PDF builder using Chromium as the rendering engine, to replaced the deprecated wkhtmltopdf based PDF builder. See https://dotnet.github.io/docfx/docs/pdf.html for more information.

What's Changed

🎉 New Features

feat: PDF builder using Chromium by @yufeih in feat: PDF builder using Chromium dotnet/docfx#9344
feat: Integration PdfBuilder into docfx by @yufeih in feat: Integration PdfBuilder into docfx dotnet/docfx#9349
feat: PDF download button by @yufeih in feat: PDF download button dotnet/docfx#9351
feat: PDF cross link to anchors by @yufeih in feat: PDF cross link to anchors dotnet/docfx#9352
feat: update template style for PDF by @yufeih in feat: update template style for PDF dotnet/docfx#9353
feat: Support PDF cover page by @yufeih in feat: Support PDF cover page dotnet/docfx#9354
feat: support PDF toc page by @yufeih in feat: support PDF toc page dotnet/docfx#9356
feat: add page number to PDF toc page by @yufeih in feat: add page number to PDF toc page dotnet/docfx#9358
feat: add page number to PDF pages by @yufeih in feat: add page number to PDF pages dotnet/docfx#9359
feat: deprecate PDF on wkhtmltopdf by @yufeih in feat: deprecate PDF on wkhtmltopdf dotnet/docfx#9360
chore: Add custom file copy logics for template files by @filzrev in chore: Add custom file copy logics for template files dotnet/docfx#9369

🐞 Bug Fixes

BREAKING CHANGE: drop configureLunr by @yufeih in BREAKING CHANGE: drop configureLunr dotnet/docfx#9342
chore: Add additional globalization settings by @filzrev in chore: Add additional globalization settings dotnet/docfx#9348
chore: Change project scoped utility class visibility to internal by @filzrev in chore: Change project scoped utility class visibility to internal dotnet/docfx#9347

🚀 Performance Improvements

perf: optimize playwright package size by @yufeih in perf: optimize playwright package size dotnet/docfx#9363
perf: skip unused scripts in pdf mode by @yufeih in perf: skip unused scripts in pdf mode dotnet/docfx#9366

📄 Documentation

docs: update PDF docs by @yufeih in docs: update PDF docs dotnet/docfx#9365

2.72.1 What's Changed

🐞 Bug Fixes

fix: git reader parsing wrong remote URL by @yufeih in fix: git reader parsing wrong remote URL dotnet/docfx#9338
fix: Remove SVG hover fill by @RobJessop in fix: Remove SVG hover fill dotnet/docfx#9340
fix: Cannot load unregistered function: stemmer-ru by @yufeih in dotnet/docfx@7eb8db7

🔧 Engineering

chore: add System.Text.Json attributes by @filzrev in chore: add System.Text.Json attributes dotnet/docfx#9341

New Contributors

@RobJessop made their first contribution in fix: Remove SVG hover fill dotnet/docfx#9340

Full Changelog: dotnet/docfx@v2.72.0...v2.72.1

2.72.0 New experimental API page output format

API Page is a new YAML output format designed to represent API documentations for a wide variety of programming languages. This release enables docfx build command to render API pages and docfx metadata command to produce API Page YAML files through the { "outputFormat": "ApiPage" } option.

What's Changed

🎉 New Features

feat: basic API page output for .NET by @yufeih in feat: basic API page output for .NET dotnet/docfx#9309
feat: api page view source by @yufeih in feat: api page view source dotnet/docfx#9318
feat: render h2/h3 for in this article section by @yufeih in feat: render h2/h3 for in this article section dotnet/docfx#9320
feat: render obsolete APIs as deprecated by @yufeih in feat: render obsolete APIs as deprecated dotnet/docfx#9319
feat: render enum field remarks and obsolete attribute by @yufeih in feat: render enum field remarks and obsolete attribute dotnet/docfx#9327
feat: support multiple search languages by @yufeih in feat: support multiple search languages dotnet/docfx#9313
Adds expander class to modern theme TOC
elements with children by @cjbotelho in Adds expander class to modern theme TOC <li> elements with children dotnet/docfx#9328

🐞 Bug Fixes

fix: scroll failed when both toc and article needs scroll by @yufeih in fix: scroll failed when both toc and article needs scroll dotnet/docfx#9321

🚀 Performance Improvements

perf: git.exe -> GitReader by @yufeih in perf: git.exe -> GitReader dotnet/docfx#9314

🔧 Engineering

test: capture crash dump on CI failure by @yufeih in test: capture crash dump on CI failure dotnet/docfx#9317

📄 Documentation

Update .NET Core SDK to .NET SDK by @WeihanLi in Update .NET Core SDK to .NET SDK dotnet/docfx#9308

New Contributors

@cjbotelho made their first contribution in Adds expander class to modern theme TOC <li> elements with children dotnet/docfx#9328

Full Changelog: dotnet/docfx@v2.71.1...v2.72.0

2.71.1 What's Changed

🎉 New Features

feat: enhance lunr search for modern template by @yufeih in feat: enhance lunr search for modern template dotnet/docfx#9264
feat: Generic API page schema by @yufeih in feat: Generic API page schema dotnet/docfx#9267

🐞 Bug Fixes

fix: Fix templates files newline to LF and apply editorconfig settings by @filzrev in chore: Fix templates files newline to LF and apply editorconfig settings dotnet/docfx#9268
fix: theme dropdown cut off by @yufeih in fix: theme dropdown cut off dotnet/docfx#9283
fix: update mermaid theme on theme change by @yufeih in fix: update mermaid theme on theme change dotnet/docfx#9307

🔧 Engineering

refactor: build command project consolidation by @yufeih in refactor: build command project consolidation dotnet/docfx#9277

Full Changelog: dotnet/docfx@v2.71.0...v2.71.1

2.71.0 What's Changed

💥 Breaking Changes

drop: remove obsolete configs by @yufeih in drop: remove some obsolete features dotnet/docfx#9221
chore: drop support of metaddata command taking non docfx.json inputs by @yufeih in chore: drop support of metaddata command taking non docfx.json inputs dotnet/docfx#9240

🎉 New Features

feat: experimental support for markdown output by @yufeih in feat: experimental support for markdown output dotnet/docfx#9232
feat: support csharp 12 by @yufeih in feat: support csharp 12 dotnet/docfx#9208
feat: add overridable metadata output json config by @yufeih in feat: add overridable metadata output json config dotnet/docfx#9237
feat: add --memberLayout argument to metadata command by @yufeih in feat: add --memberLayout argument to metadata command dotnet/docfx#9244

🐞 Bug Fixes

fix: xml comment math inline escape by @yufeih in fix: xml comment math inline escape dotnet/docfx#9220
fix: anchor sometimes failed to scroll by @yufeih in fix: anchor sometimes failed to scroll dotnet/docfx#9251

🔧 Engineering

chore: Suppress messages generated by CodeAnalyzers by @filzrev in chore: Suppress messages generated by CodeAnalyzers dotnet/docfx#9224

Full Changelog: dotnet/docfx@v2.70.4...v2.71.0

Commits viewable in compare view.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

--- updated-dependencies: - dependency-name: docfx dependency-version: 2.78.4 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

Bump docfx from 2.70.4 to 2.78.4

342f920

--- updated-dependencies: - dependency-name: docfx dependency-version: 2.78.4 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>

dependabot bot added dependencies Pull requests that update a dependency file .NET Pull requests that update .NET code labels Dec 5, 2025

PTKu merged commit 5aed826 into dev Dec 5, 2025

dependabot bot deleted the dependabot/nuget/dot-config/docfx-2.78.4 branch December 5, 2025 14:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Bump docfx from 2.70.4 to 2.78.4 #909

Bump docfx from 2.70.4 to 2.78.4 #909

Uh oh!

dependabot bot commented on behalf of github Dec 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Bump docfx from 2.70.4 to 2.78.4 #909

Bump docfx from 2.70.4 to 2.78.4 #909

Uh oh!

Conversation

dependabot bot commented on behalf of github Dec 5, 2025

2.78.4

🚀 Release Notes

🌟 New Features

🐞 Bug Fixes

⚡ Performance Improvements

📘 Documentation Updates

🙌 Contributors

2.78.3

What's Changed

🎉 New Features

🐞 Bug Fixes

🚀 Performance Improvements

New Contributors

2.78.2

What's Changed

🎉 New Features

🐞 Bug Fixes

📄 Documentation

💪 Other Changes

New Contributors

2.78.1

What's Changed

🐞 Bug Fixes

2.78.0

What's Changed

💥 Breaking Changes

🎉 New Features

🐞 Bug Fixes

📄 Documentation

New Contributors

2.77.0

What's Changed

💥 Breaking Changes

🎉 New Features

🐞 Bug Fixes

🚀 Performance Improvements

🔧 Engineering

📄 Documentation

New Contributors

2.76.0

What's Changed

🎉 New Features

🐞 Bug Fixes

🚀 Performance Improvements

🔧 Engineering

📄 Documentation

New Contributors

2.75.3

What's Changed

🐞 Bug Fixes

🔧 Engineering

2.75.2

What's Changed

🐞 Bug Fixes

🚀 Performance Improvements

🔧 Engineering

📄 Documentation

New Contributors

2.75.1

What's Changed

🎉 New Features

🐞 Bug Fixes

📄 Documentation

2.75.0

What's Changed

💥 Breaking Changes

🎉 New Features

🐞 Bug Fixes

🔧 Engineering

📄 Documentation

New Contributors

2.74.1

What's Changed

🎉 New Features

🐞 Bug Fixes