docfx

What's Changed

💥 Breaking Changes

• chore: Drop .NET 7 SDK supports by @filzrev in https://github.com/dotnet/docfx/pull/9911

🎉 New Features

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

🐞 Bug Fixes

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

🚀 Performance Improvements

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

🔧 Engineering

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

📄 Documentation

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

New Contributors

• @carlos-regis made their first contribution in https://github.com/dotnet/docfx/pull/9871
• @si618 made their first contribution in https://github.com/dotnet/docfx/pull/9881
• @Patrick8639 made their first contribution in https://github.com/dotnet/docfx/pull/9957

Full Changelog: https://github.com/dotnet/docfx/compare/v2.76.0...v2.77.0

What's Changed

🎉 New Features

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

🐞 Bug Fixes

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

🚀 Performance Improvements

• perf: Optimize xrefmap.json file deserialization performance by @filzrev in https://github.com/dotnet/docfx/pull/9824

🔧 Engineering

• chore: percy snapshot by @yufeih in https://github.com/dotnet/docfx/pull/9747
• chore: Add detailed error message for specific exceptions by @filzrev in https://github.com/dotnet/docfx/pull/9746
• chore: update pdfpig nuget package version by @filzrev in https://github.com/dotnet/docfx/pull/9803

📄 Documentation

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

New Contributors

• @EMaderbacher made their first contribution in https://github.com/dotnet/docfx/pull/9762
• @fuzzykiller made their first contribution in https://github.com/dotnet/docfx/pull/9768
• @soniyaprasad77 made their first contribution in https://github.com/dotnet/docfx/pull/9806
• @tbolon made their first contribution in https://github.com/dotnet/docfx/pull/9810
• @peitschie made their first contribution in https://github.com/dotnet/docfx/pull/9812
• @voroninp made their first contribution in https://github.com/dotnet/docfx/pull/9828

Full Changelog: https://github.com/dotnet/docfx/compare/v2.75.3...v2.76.0

What's Changed

🎉 New Features

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

🐞 Bug Fixes

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

🚀 Performance Improvements

• perf: Optimize xrefmap.json file deserialization performance by @filzrev in https://github.com/dotnet/docfx/pull/9824

🔧 Engineering

• chore: percy snapshot by @yufeih in https://github.com/dotnet/docfx/pull/9747
• chore: Add detailed error message for specific exceptions by @filzrev in https://github.com/dotnet/docfx/pull/9746
• chore: update pdfpig nuget package version by @filzrev in https://github.com/dotnet/docfx/pull/9803

📄 Documentation

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

New Contributors

• @EMaderbacher made their first contribution in https://github.com/dotnet/docfx/pull/9762
• @fuzzykiller made their first contribution in https://github.com/dotnet/docfx/pull/9768
• @soniyaprasad77 made their first contribution in https://github.com/dotnet/docfx/pull/9806
• @tbolon made their first contribution in https://github.com/dotnet/docfx/pull/9810
• @peitschie made their first contribution in https://github.com/dotnet/docfx/pull/9812
• @voroninp made their first contribution in https://github.com/dotnet/docfx/pull/9828

Full Changelog: https://github.com/dotnet/docfx/compare/v2.75.3...v2.76.0

What's Changed

🐞 Bug Fixes

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

🔧 Engineering

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

Full Changelog: https://github.com/dotnet/docfx/compare/v2.75.2...v2.75.3

What's Changed

🐞 Bug Fixes

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

🚀 Performance Improvements

• pref: Optimize xrefmap download performance by @filzrev in https://github.com/dotnet/docfx/pull/9637

🔧 Engineering

• chore: Update Verify.Xunit dependencies by @filzrev in https://github.com/dotnet/docfx/pull/9624
• chore: Update YamlDotNet version by @filzrev in https://github.com/dotnet/docfx/pull/9654

📄 Documentation

• Markdig extensions configuration/support documentation by @cjlotz in https://github.com/dotnet/docfx/pull/9615

New Contributors

• @BattlefieldDuck made their first contribution in https://github.com/dotnet/docfx/pull/9648

Full Changelog: https://github.com/dotnet/docfx/compare/v2.75.1...v2.75.2

What's Changed

🎉 New Features

• feat: Include API summary in tag by @yufeih in https://github.com/dotnet/docfx/pull/9611

🐞 Bug Fixes

• fix: remove PDF missing TOC warning by @yufeih in https://github.com/dotnet/docfx/pull/9610

📄 Documentation

• Updated docs to include PlantUML extension by @cjlotz in https://github.com/dotnet/docfx/pull/9607

Full Changelog: https://github.com/dotnet/docfx/compare/v2.75.0...v2.75.1

What's Changed

💥 Breaking Changes

• BREAKING CHAGNE: drop name.vb from toc output by @yufeih in https://github.com/dotnet/docfx/pull/9530
• BREAKING CHANGE: drop pdf on wkhtmltopdf by @yufeih in https://github.com/dotnet/docfx/pull/9555

🎉 New Features

• feat: Support PlantUml by @cjlotz in https://github.com/dotnet/docfx/pull/9574
• feat: Support solution filter file (.slnf) by @filzrev in https://github.com/dotnet/docfx/pull/9513
• feat: Support git submodule by @georghinkel in https://github.com/dotnet/docfx/pull/9540
• feat: Support PDF header footer template by @yufeih in https://github.com/dotnet/docfx/pull/9543
• feat: Support description metadata by @yufeih in https://github.com/dotnet/docfx/pull/9585

🐞 Bug Fixes

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

🔧 Engineering

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

📄 Documentation

• Update documentation readme by @JM2K69 in https://github.com/dotnet/docfx/pull/9600

New Contributors

• @georghinkel made their first contribution in https://github.com/dotnet/docfx/pull/9540
• @jwfx made their first contribution in https://github.com/dotnet/docfx/pull/9554
• @cjlotz made their first contribution in https://github.com/dotnet/docfx/pull/9574
• @Egliss made their first contribution in https://github.com/dotnet/docfx/pull/9605

Full Changelog: https://github.com/dotnet/docfx/compare/v2.74.1...v2.75.0

What's Changed

🎉 New Features

• feat: support <exclude /> documentation comment by @yufeih in https://github.com/dotnet/docfx/pull/9492
• feat: auto-generate TOC name from title by @yufeih in https://github.com/dotnet/docfx/pull/9475 https://github.com/dotnet/docfx/pull/9481
• feat: toggle log severity using rules config by @yufeih in https://github.com/dotnet/docfx/pull/9460
• feat: Add option for including explicit interface implementations by @yufeih in https://github.com/dotnet/docfx/pull/9471

🐞 Bug Fixes

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

📄 Documentation

• docs: fix broken link in filters by @natakazakova in https://github.com/dotnet/docfx/pull/9486

Full Changelog: https://github.com/dotnet/docfx/compare/v2.74.0...v2.74.1

What's Changed

💥 Breaking Changes

• BREAKING CHANGE: drop log_code from manifest by @yufeih in https://github.com/dotnet/docfx/pull/9413
• BREAKING CHANGE: drop keepFileLink by @yufeih in https://github.com/dotnet/docfx/pull/9417
• BREAKING CHAGNE: change some internal types from public to internal by @yufeih in https://github.com/dotnet/docfx/pull/9401

🎉 New Features

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

🔧 Engineering

• chore: Remove NuGet.Frameworks dependency from test projects by @filzrev in https://github.com/dotnet/docfx/pull/9276

📄 Documentation

• Fix the github actions not working properly in the newest versions of docfx with default settings by @ysftulek in https://github.com/dotnet/docfx/pull/9430

New Contributors

• @ysftulek made their first contribution in https://github.com/dotnet/docfx/pull/9430

Full Changelog: https://github.com/dotnet/docfx/compare/v2.73.2...v2.74.0

What's Changed

🎉 New Features

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

🐞 Bug Fixes

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

🔧 Engineering

• test: run snapshot test on windows by @yufeih in https://github.com/dotnet/docfx/pull/9397

New Contributors

• @JM2K69 made their first contribution in https://github.com/dotnet/docfx/pull/9392

Full Changelog: https://github.com/dotnet/docfx/compare/v2.73.1...v2.73.2

What's Changed

🎉 New Features

• feat: update init command by @yufeih in https://github.com/dotnet/docfx/pull/9377

🐞 Bug Fixes

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

🚀 Performance Improvements

• perf: print page numbers using PdfPig by @yufeih in https://github.com/dotnet/docfx/pull/9381

Full Changelog: https://github.com/dotnet/docfx/compare/v2.73.0...v2.73.1

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 https://github.com/dotnet/docfx/pull/9344
• feat: Integration PdfBuilder into docfx by @yufeih in https://github.com/dotnet/docfx/pull/9349
• feat: PDF download button by @yufeih in https://github.com/dotnet/docfx/pull/9351
• feat: PDF cross link to anchors by @yufeih in https://github.com/dotnet/docfx/pull/9352
• feat: update template style for PDF by @yufeih in https://github.com/dotnet/docfx/pull/9353
• feat: Support PDF cover page by @yufeih in https://github.com/dotnet/docfx/pull/9354
• feat: support PDF toc page by @yufeih in https://github.com/dotnet/docfx/pull/9356
• feat: add page number to PDF toc page by @yufeih in https://github.com/dotnet/docfx/pull/9358
• feat: add page number to PDF pages by @yufeih in https://github.com/dotnet/docfx/pull/9359
• feat: deprecate PDF on wkhtmltopdf by @yufeih in https://github.com/dotnet/docfx/pull/9360
• chore: Add custom file copy logics for template files by @filzrev in https://github.com/dotnet/docfx/pull/9369

🐞 Bug Fixes

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

🚀 Performance Improvements

• perf: optimize playwright package size by @yufeih in https://github.com/dotnet/docfx/pull/9363
• perf: skip unused scripts in pdf mode by @yufeih in https://github.com/dotnet/docfx/pull/9366

📄 Documentation

• docs: update PDF docs by @yufeih in https://github.com/dotnet/docfx/pull/9365

What's Changed

🐞 Bug Fixes

• fix: git reader parsing wrong remote URL by @yufeih in https://github.com/dotnet/docfx/pull/9338
• fix: Remove SVG hover fill by @RobJessop in https://github.com/dotnet/docfx/pull/9340
• fix: Cannot load unregistered function: stemmer-ru by @yufeih in https://github.com/dotnet/docfx/commit/7eb8db76d90eab20141e7a5a2a8ce6c1edefd252

🔧 Engineering

• chore: add System.Text.Json attributes by @filzrev in https://github.com/dotnet/docfx/pull/9341

New Contributors

• @RobJessop made their first contribution in https://github.com/dotnet/docfx/pull/9340

Full Changelog: https://github.com/dotnet/docfx/compare/v2.72.0...v2.72.1

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 https://github.com/dotnet/docfx/pull/9309
• feat: api page view source by @yufeih in https://github.com/dotnet/docfx/pull/9318
• feat: render h2/h3 for in this article section by @yufeih in https://github.com/dotnet/docfx/pull/9320
• feat: render obsolete APIs as deprecated by @yufeih in https://github.com/dotnet/docfx/pull/9319
• feat: render enum field remarks and obsolete attribute by @yufeih in https://github.com/dotnet/docfx/pull/9327
• feat: support multiple search languages by @yufeih in https://github.com/dotnet/docfx/pull/9313
• Adds expander class to modern theme TOC elements with children by @cjbotelho in https://github.com/dotnet/docfx/pull/9328

🐞 Bug Fixes

• fix: scroll failed when both toc and article needs scroll by @yufeih in https://github.com/dotnet/docfx/pull/9321

🚀 Performance Improvements

• perf: git.exe -> GitReader by @yufeih in https://github.com/dotnet/docfx/pull/9314

🔧 Engineering

• test: capture crash dump on CI failure by @yufeih in https://github.com/dotnet/docfx/pull/9317

📄 Documentation

• Update .NET Core SDK to .NET SDK by @WeihanLi in https://github.com/dotnet/docfx/pull/9308

New Contributors

• @cjbotelho made their first contribution in https://github.com/dotnet/docfx/pull/9328

Full Changelog: https://github.com/dotnet/docfx/compare/v2.71.1...v2.72.0

What's Changed

🎉 New Features

• feat: enhance lunr search for modern template by @yufeih in https://github.com/dotnet/docfx/pull/9264
• feat: Generic API page schema by @yufeih in https://github.com/dotnet/docfx/pull/9267

🐞 Bug Fixes

• fix: Fix templates files newline to LF and apply editorconfig settings by @filzrev in https://github.com/dotnet/docfx/pull/9268
• fix: theme dropdown cut off by @yufeih in https://github.com/dotnet/docfx/pull/9283
• fix: update mermaid theme on theme change by @yufeih in https://github.com/dotnet/docfx/pull/9307

🔧 Engineering

• refactor: build command project consolidation by @yufeih in https://github.com/dotnet/docfx/pull/9277

Full Changelog: https://github.com/dotnet/docfx/compare/v2.71.0...v2.71.1

What's Changed

💥 Breaking Changes

• drop: remove obsolete configs by @yufeih in https://github.com/dotnet/docfx/pull/9221
• chore: drop support of metaddata command taking non docfx.json inputs by @yufeih in https://github.com/dotnet/docfx/pull/9240

🎉 New Features

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

🐞 Bug Fixes

• fix: xml comment math inline escape by @yufeih in https://github.com/dotnet/docfx/pull/9220
• fix: anchor sometimes failed to scroll by @yufeih in https://github.com/dotnet/docfx/pull/9251

🔧 Engineering

• chore: Suppress messages generated by CodeAnalyzers by @filzrev in https://github.com/dotnet/docfx/pull/9224

Full Changelog: https://github.com/dotnet/docfx/compare/v2.70.4...v2.71.0

What's Changed

🐞 Bug Fixes

• fix: Support extension methods defined in same class name different assemblies by @yufeih in https://github.com/dotnet/docfx/pull/9209
• fix: Remove min 3 char limit before search by @filzrev in https://github.com/dotnet/docfx/pull/9182
• fix: Remove unused localsearch function from default template by @filzrev in https://github.com/dotnet/docfx/pull/9201
• fix: default/partials/title.tmpl.partial file typo by @filzrev in https://github.com/dotnet/docfx/pull/9206

🔧 Engineering

• chore: Update .NET SDK 8 to RC1 and fix node version by @filzrev in https://github.com/dotnet/docfx/pull/9202

📄 Documentation

• Mentioned "_appName" in the reference docs. by @acureau in https://github.com/dotnet/docfx/pull/9196

New Contributors

• @acureau made their first contribution in https://github.com/dotnet/docfx/pull/9196

Full Changelog: https://github.com/dotnet/docfx/compare/v2.70.3...v2.70.4

🐞 Bug Fixes

• fix: Localized language broken by @yufeih in https://github.com/dotnet/docfx/commit/3968fc5e92ebc2e4a2d97df0105000af2ec7eb82

Full Changelog: https://github.com/dotnet/docfx/compare/v2.70.2...v2.70.3

What's Changed

🎉 New Features

• feat: Support modern template localization by @yufeih in https://github.com/dotnet/docfx/pull/9154
• feat: Support language attribute on C# documentation comment by @yufeih in https://github.com/dotnet/docfx/pull/9159

🐞 Bug Fixes

• fix: TOC filter text not reset by @yufeih in https://github.com/dotnet/docfx/pull/9125
• fix: Make blockquote more obvious by @yufeih in https://github.com/dotnet/docfx/pull/9130
• fix: Remove document type template bundle warning by @yufeih in https://github.com/dotnet/docfx/pull/9133
• fix: Update msbuild.locator to 1.6.1 by @yufeih in https://github.com/dotnet/docfx/pull/9153
• chore: Change output html file encoding to UTF-8 (No BOM) by @filzrev in https://github.com/dotnet/docfx/pull/9131

🚀 Performance Improvements

• perf: Reduce dotnet tool NuGet package size by @filzrev in https://github.com/dotnet/docfx/pull/9115
• perf: Replace ArrayDictionary to ConcurrentDictionary by @filzrev in https://github.com/dotnet/docfx/pull/9121
• perf: Optimize read MIME operation by @filzrev in https://github.com/dotnet/docfx/pull/9132
• perf: Change JsonSerializerOptions instance to static by @filzrev in https://github.com/dotnet/docfx/pull/9163

🔧 Engineering

• chore: Add code coverage exclusions by @filzrev in https://github.com/dotnet/docfx/pull/9118
• chore: Update .NET SDK for CI by @filzrev in https://github.com/dotnet/docfx/pull/9139
• build(deps): bump Microsoft.Build from 17.3.2 to 17.7.2 by @filzrev in https://github.com/dotnet/docfx/pull/9138
• chore: Refactor docfx command related code by @filzrev in https://github.com/dotnet/docfx/pull/9140
• chore: Remove unused code by @filzrev in https://github.com/dotnet/docfx/pull/9164

Full Changelog: https://github.com/dotnet/docfx/compare/v2.70.1...v2.70.2

What's Changed

🎉 New Features

• Disable cert revoke list check using env variable DOCFX_NO_CHECK_CERTIFICATE_REVOCATION_LIST by @yufeih in https://github.com/dotnet/docfx/pull/9017
• Option to sort enum member in declaring order by @yufeih in https://github.com/dotnet/docfx/pull/9093
• Add type definition to REST API pages by @yufeih in https://github.com/dotnet/docfx/pull/9066

🐞 Bug Fixes

• Fix TOC max height size by @MihkelAuv in https://github.com/dotnet/docfx/pull/9035
• Fix nav & toc active state breaks with external urls by @Lulalaby in https://github.com/dotnet/docfx/pull/9038
• Fix affix max height size by @MihkelAuv in https://github.com/dotnet/docfx/pull/9053
• Remove unused dependency by @filzrev in https://github.com/dotnet/docfx/pull/9101

🚀 Performance Improvements

• Reduce lock wait when checking git command exists or not by @filzrev in https://github.com/dotnet/docfx/pull/9074
• Optimize templates resource loading performance by @filzrev in https://github.com/dotnet/docfx/pull/9090
• Optimize JToken to Dictionary conversion performance by @filzrev in https://github.com/dotnet/docfx/pull/9096

🔧 Engineering

• Update Node.js and package dependencies by @filzrev in https://github.com/dotnet/docfx/pull/9009
• Reorganize editorconfig settings by @filzrev in https://github.com/dotnet/docfx/pull/9019
• Update .NET8 SDK version for CI by @filzrev in https://github.com/dotnet/docfx/pull/9015
• Fix code formatting by @filzrev in https://github.com/dotnet/docfx/pull/9025
• Rewrite parameter null checks using helper methods by @filzrev in https://github.com/dotnet/docfx/pull/9024
• Cleanup tests and fix spellings by @filzrev in https://github.com/dotnet/docfx/pull/9091
• Add code coverage exclusions by @filzrev in https://github.com/dotnet/docfx/pull/9102

📄 Documentation

• Add docs for docfx environment variables by @filzrev in https://github.com/dotnet/docfx/pull/9020
• Remove obsolete doc and fix doc comments by @filzrev in https://github.com/dotnet/docfx/pull/9018

Full Changelog: https://github.com/dotnet/docfx/compare/v2.70.0...v2.70.1