Releases: dotnet/docfx
Releases · dotnet/docfx
v2.78.2
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
💪 Other Changes
- chore: Add published package tests to nightly build workflow by @filzrev in #10403
- chore: Update
Dockerfileby @filzrev in #10407
New Contributors
- @hultqvist made their first contribution in #10372
Full Changelog: 2.78.1...2.78.2
Contributors
hultqvist, RobJessop, and filzrev
Assets 5
v2.78.1
v2.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 #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
CancellationTokensupport forRunBuild.Execby @filzrev in #10185 - feat: add
AllowUnsafeBlockssupports 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
nameWithTypeoption 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, and 9 other contributors
Assets 5
v2.77.0
What's Changed
💥 Breaking Changes
🎉 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.jsontransform logics usingtoc.extension.jsby @filzrev in #9953 - feat: Better error when link not found by @Patrick8639 in #9957
- feat: Add
categoryLayoutoption 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
Producerdocument 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 metadatacommand throwArgumentExceptionwhen 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 packcommand 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, and 4 other contributors
Assets 5
v2.76.0
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 downloadcommand 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
_disabledTocwhen 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
🔧 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.jsonconfig reference document by @filzrev in #9813 - docs: Correct
docfx templatepage 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, and 7 other contributors
Assets 5
v2.75.3
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
--serveoption 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
AutoVerifyon 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
Assets 5
v2.75.2
What's Changed
🐞 Bug Fixes
- fix: mref mustach template description leak by @yufeih in #9632
- fix: When
disableDefaultFilteris 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
🔧 Engineering
- chore: Update
Verify.Xunitdependencies by @filzrev in #9624 - chore: Update YamlDotNet version by @filzrev in #9654
📄 Documentation
New Contributors
- @BattlefieldDuck made their first contribution in #9648
Full Changelog: v2.75.1...v2.75.2
Contributors
yufeih, cjlotz, and 2 other contributors
Assets 5
v2.75.1
Contributors
yufeih and cjlotz
Assets 5
v2.75.0
What's Changed
💥 Breaking Changes
- BREAKING CHAGNE: drop name.vb from toc output by @yufeih in #9530
- BREAKING CHANGE: drop pdf on wkhtmltopdf by @yufeih in #9555
🎉 New Features
- feat: Support PlantUml by @cjlotz in #9574
- feat: Support solution filter file (.slnf) by @filzrev in #9513
- feat: Support git submodule by @georghinkel in #9540
- feat: Support PDF header footer template by @yufeih in #9543
- feat: Support description metadata by @yufeih in #9585
🐞 Bug Fixes
- fix: Docset Pdf call terminating early by @dpvreony in #9493
- fix: Code copy not shown on collapsed divs by @yufeih in #9531
- fix: PDF wait for network idle by @yufeih in #9542
- fix: Hide the Docfx templates folder from VS project tree by @jwfx in #9554
- fix: Fix picture image click event handling by @filzrev in #9575
- fix: Warn on PDF timeout by @yufeih in #9586
- fix: Fix japanese search by @Egliss in #9605
🔧 Engineering
- Bump docker image to SDK .NET 8 by @JM2K69 in #9501
- build: upgrade to Jint 3.0.0-beta-2059 by @lahma in #9583
- build(deps): update nuget dependencies by @filzrev in #9587
📄 Documentation
New Contributors
- @georghinkel made their first contribution in #9540
- @jwfx made their first contribution in #9554
- @cjlotz made their first contribution in #9574
- @Egliss made their first contribution in #9605
Full Changelog: v2.74.1...v2.75.0
Contributors
dpvreony, lahma, and 7 other contributors
Assets 5
v2.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 #9515 for details.
What's Changed
🎉 New Features
- feat: support <exclude /> documentation comment by @yufeih in #9492
- feat: auto-generate TOC name from title by @yufeih in #9475 #9481
- feat: toggle log severity using rules config by @yufeih in #9460
- feat: Add option for including explicit interface implementations by @yufeih in #9471
🐞 Bug Fixes
- fix: log message text break at 80 columns by @yufeih in #9464
- fix: affix display problem on ios by @yufeih in #9470
- fix: xml indentation issue on external <code> by @yufeih in #9465
- fix: only allow first h1 to be the title by @yufeih in #9474
- fix: make
_tocReldeterministic by @yufeih in #9483 - fix: filter compiler generated helpers by @yufeih in #9489
- fix: PDB symbol link respect disable git features by @yufeih in #9490
- fix: class level seealso leaked to members by @yufeih in #9491
📄 Documentation
- docs: fix broken link in filters by @natakazakova in #9486
Full Changelog: v2.74.0...v2.74.1
Contributors
yufeih and natakazakova