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

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

v2.75.2

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

v2.75.1

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

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

• Update documentation readme by @JM2K69 in #9600

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

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 _tocRel deterministic 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

v2.74.0

What's Changed

💥 Breaking Changes

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

🎉 New Features

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

🔧 Engineering

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

📄 Documentation

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

New Contributors

• @ysftulek made their first contribution in #9430

Full Changelog: v2.73.2...v2.74.0

v2.73.2

What's Changed

🎉 New Features

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

🐞 Bug Fixes

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

🔧 Engineering

• test: run snapshot test on windows by @yufeih in #9397

New Contributors

• @JM2K69 made their first contribution in #9392

Full Changelog: v2.73.1...v2.73.2

v2.73.1

What's Changed

🎉 New Features

• feat: update init command by @yufeih in #9377

🐞 Bug Fixes

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

🚀 Performance Improvements

• perf: print page numbers using PdfPig by @yufeih in #9381

Full Changelog: v2.73.0...v2.73.1

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

🐞 Bug Fixes

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

🚀 Performance Improvements

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

📄 Documentation

• docs: update PDF docs by @yufeih in #9365