Skip to content

Releases: dotnet/docfx

v2.77.0

01 Jul 02:23
bd00e2b
Compare
Choose a tag to compare

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.json transform logics using toc.extension.js by @filzrev in #9953
  • feat: Better error when link not found by @Patrick8639 in #9957
  • feat: Add categoryLayout option for metadata generation by @filzrev in #9965
  • feat: Permits to specify the placement of overwrites by @Patrick8639 in #9937
  • feat: Support private symbols by @Patrick8639 in #9972
  • feat: Add support for gzipped xrefmap that stored as local file by @filzrev in #9966
  • feat: Enable view transitions feature by @filzrev in #9909

🐞 Bug Fixes

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

πŸš€ Performance Improvements

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

πŸ”§ Engineering

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

πŸ“„ Documentation

New Contributors

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

v2.76.0

07 Apr 03:29
0f64359
Compare
Choose a tag to compare

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

πŸ“„ 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

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

v2.75.3

18 Feb 07:31
Compare
Choose a tag to compare

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

27 Jan 13:02
fe673ec
Compare
Choose a tag to compare

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

πŸ“„ Documentation

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

New Contributors

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

v2.75.1

13 Jan 07:48
6aa697f
Compare
Choose a tag to compare

What's Changed

πŸŽ‰ New Features

🐞 Bug Fixes

πŸ“„ Documentation

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

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

v2.75.0

12 Jan 07:49
8851faa
Compare
Choose a tag to compare

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

🐞 Bug Fixes

πŸ”§ Engineering

πŸ“„ Documentation

New Contributors

Full Changelog: v2.74.1...v2.75.0

v2.74.1

30 Nov 11:23
Compare
Choose a tag to compare

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

Full Changelog: v2.74.0...v2.74.1

v2.74.0

20 Nov 06:48
0a19218
Compare
Choose a tag to compare

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

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

v2.73.2

13 Nov 12:59
Compare
Choose a tag to compare

What's Changed

πŸŽ‰ New Features

🐞 Bug Fixes

πŸ”§ Engineering

New Contributors

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

v2.73.1

07 Nov 03:33
Compare
Choose a tag to compare

What's Changed

πŸŽ‰ New Features

🐞 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

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