Releases: dotnet/docfx
Releases ยท dotnet/docfx
v2.70.2
What's Changed
๐ New Features
- feat: Support modern template localization by @yufeih in #9154
- feat: Support language attribute on C# documentation comment by @yufeih in #9159
๐ Bug Fixes
- fix: TOC filter text not reset by @yufeih in #9125
- fix: Make blockquote more obvious by @yufeih in #9130
- fix: Remove document type template bundle warning by @yufeih in #9133
- fix: Update msbuild.locator to 1.6.1 by @yufeih in #9153
- chore: Change output html file encoding to UTF-8 (No BOM) by @filzrev in #9131
๐ Performance Improvements
- perf: Reduce dotnet tool NuGet package size by @filzrev in #9115
- perf: Replace ArrayDictionary to ConcurrentDictionary by @filzrev in #9121
- perf: Optimize read MIME operation by @filzrev in #9132
- perf: Change JsonSerializerOptions instance to static by @filzrev in #9163
๐ง Engineering
- chore: Add code coverage exclusions by @filzrev in #9118
- chore: Update .NET SDK for CI by @filzrev in #9139
- build(deps): bump Microsoft.Build from 17.3.2 to 17.7.2 by @filzrev in #9138
- chore: Refactor docfx command related code by @filzrev in #9140
- chore: Remove unused code by @filzrev in #9164
Full Changelog: v2.70.1...v2.70.2
v2.70.1
What's Changed
๐ New Features
- Disable cert revoke list check using env variable DOCFX_NO_CHECK_CERTIFICATE_REVOCATION_LIST by @yufeih in #9017
- Option to sort enum member in declaring order by @yufeih in #9093
- Add type definition to REST API pages by @yufeih in #9066
๐ Bug Fixes
- Fix TOC max height size by @MihkelAuv in #9035
- Fix nav & toc active state breaks with external urls by @Lulalaby in #9038
- Fix affix max height size by @MihkelAuv in #9053
- Remove unused dependency by @filzrev in #9101
๐ Performance Improvements
- Reduce lock wait when checking git command exists or not by @filzrev in #9074
- Optimize templates resource loading performance by @filzrev in #9090
- Optimize JToken to Dictionary conversion performance by @filzrev in #9096
๐ง Engineering
- Update Node.js and package dependencies by @filzrev in #9009
- Reorganize editorconfig settings by @filzrev in #9019
- Update .NET8 SDK version for CI by @filzrev in #9015
- Fix code formatting by @filzrev in #9025
- Rewrite parameter null checks using helper methods by @filzrev in #9024
- Cleanup tests and fix spellings by @filzrev in #9091
- Add code coverage exclusions by @filzrev in #9102
๐ Documentation
- Add docs for docfx environment variables by @filzrev in #9020
- Remove obsolete doc and fix doc comments by @filzrev in #9018
Full Changelog: v2.70.0...v2.70.1
v2.70.0
Docfx as .NET Foundation Project
Starting from v2.70.0
, docfx has been fully transitioned to be a .NET Foundation project entirely driven by the community for the interest of the community.
Given the ownership change, we are renaming the NuGet package names, assembly names and namespace names from Microsoft.DocAsCode.*
to Docfx.*
.
What's Changed
๐ฅ Breaking Changes
- Microsoft.DocAsCode.* -> Docfx.* by @yufeih in #8943
- Drop Docfx.MarkdigEngine.Validators by @yufeih in #8971
- Drop support for md.style by @yufeih in #8973
๐ New Features
- Sign and publish as .NET foundation by @yufeih in #8931
- Expand active page when it has subpages on modern template by @MihkelAuv in #8896
- Enable invariant culture by @yufeih in #8897
- Add redirection document type by @filzrev in #8892
- Add open browser options to
docfx serve
command by @filzrev in #8934 - Add PDF generation ability to
Docfx.App
by @dpvreony in #8939
๐ Bug Fixes
- Fix scroll into view in TOC by @MihkelAuv in #8898
- Fix console logger message format by @filzrev in #8916
- Fix serialization related property name problems by @filzrev in #8941
- Remove tab group hash function by @yufeih in #8942
- See/seealso tag copies href when a child node exist by @yufeih in #8974
- Display unresolved cref by @yufeih in #8975
- Fix for modifying an enumerated collection while traversing it. by @mihtjel in #8972
- Backport triple colon extension updates by @yufeih in #9000
๐ง Engineering
- Fix warning NU1701 by @filzrev in #8904
- Apply build-in code formatters by @filzrev in #8912
- Add default launchSettings.json by @filzrev in #8935
- Remove obsolete warning suppression. and fix deprecated APIs by @filzrev in #8937
- Add FluentAssertions nuget package to test projects by @filzrev in #8946
- Update SpellingExclusions.dic by @filzrev in #8970
- Change dependabot schedule to daily by @filzrev in #8982
- Update NuGet package version of ICSharpCode.Decompiler by @filzrev in #8983
- Add Visual Studio Spell Check config settings. And fix reported spellings problems by @filzrev in #8940
๐ Documentation
- Typo fix by @novialriptide in #8908
- Copyedits of CLI and docfx.json pages by @rgarrity in #8989
- Add doc comments to docfx.json related config files. by @filzrev in #8969
New Contributors
- @MihkelAuv made their first contribution in #8896
- @novialriptide made their first contribution in #8908
- @mihtjel made their first contribution in #8972
- @dpvreony made their first contribution in #8939
- @rgarrity made their first contribution in #8989
Full Changelog: v2.67.5...v2.70.0
v2.67.5
What's Changed
๐ New Features
- feat: update copyright to .NET Foundation and Contributors by @yufeih in #8867
- feat: reduce NuGet package size by @filzrev in #8876
๐ Bug Fixes
- fix: globalMetadataFiles and fileMetadataFiles not working by @yufeih in #8828
- fix: theme button not refreshed on change by @yufeih in #8853
- fix: Uncaught TypeError: $(...).mark is not a function by @yufeih in #8885
- fix: Enable InvalidFileLink check when custom hrefGenerator is used by @filzrev in #8845
๐ Documentation
- docs: documentation of template.md by @filzrev in #8849
- docs: updated material template screenshot by @ovasquez in #8852
๐ง Engineering
Full Changelog: v2.67.3...v2.67.5
v2.67.4
What's Changed
๐ New Features
- feat: update copyright to .NET Foundation and Contributors by @yufeih in #8867
- feat: reduce NuGet package size by @filzrev in #8876
๐ Bug Fixes
- fix: globalMetadataFiles and fileMetadataFiles not working by @yufeih in #8828
- fix: theme button not refreshed on change by @yufeih in #8853
- fix: Uncaught TypeError: $(...).mark is not a function by @yufeih in #8885
- fix: Enable InvalidFileLink check when custom hrefGenerator is used by @filzrev in #8845
๐ Documentation
- docs: documentation of template.md by @filzrev in #8849
- docs: updated material template screenshot by @ovasquez in #8852
Full Changelog: v2.67.3...v2.67.4
v2.67.3
What's Changed
๐ New Features
- feat: support load plugins from template by @yufeih in #8812
- feat: update default template to allow google analytics from metadata by @SeanKilleen in #8799
- feat: specify global metadata with -m|--metadata arg by @yufeih in #8816
- perf: optimize default plugin load speed by @yufeih in #8810
๐ Bug Fixes
๐ง Engineering
๐ Documentation
New Contributors
Full Changelog: v2.67.2...v2.67.3
v2.67.2
What's Changed
๐ New Features
- feat: update Microsoft.CodeAnalysis from 4.5.0 to 4.6.0 #8793
๐ Bug Fixes
- fix: updated highlight.js default themes to vs and vs2015 (dark-mode) by @yufeih in #8778
- fix: allow dash as tag name in markdig code snippet syntax by @yufeih in #8783
- fix: array options not bound to command line args by @yufeih in #8784
Full Changelog: v2.67.1...v2.67.2
v2.67.1
What's Changed
๐ New Features
๐ง Engineering
๐ Documentation
- docs: fix template js example by @Lulalaby in #8741
- docs: update basic-concepts.md - added missing
on
word. by @VaclavElias in #8755 - docs: add info about uid in toc by @Lulalaby in #8752
- docs: fix pdf documentation by @Lulalaby in #8758
Full Changelog: v2.67.0...v2.67.1
v2.67.0
What's Changed
๐ฅ Breaking Changes
- #8682: If you have a custom template based on the modern template, rename the
styles
folder topublic
for the modern template to locate custom scripts and styles inmain.js
andmain.css
.
๐ New Features
- feat: add TOC filter for modern template by @yufeih in #8719
- feat: support navbar dropdown button by @yufeih in #8694
- feat: add modern template customization options by @yufeih in #8682
- feat: support HTML lang by @yufeih in #8704
- feat: allow custom alert types by @yufeih in #8735
- feat: add _appLogoUrl metadata by @yufeih in #8737
- feat: Enable google analytics with
_googleAnalyticsTagId
metadata in by @yufeih in #8733 - feat: add an option to disable new tabs in modern template by @yufeih in #8718
๐ Bug Fixes
- fix: typedConstant NRE by @yufeih in #8698
- fix: make postprocessors work again by @InFTord in #8700
- fix: nested namespace apply template error by @yufeih in #8738
- fix: add output config overridable by --output by @yufeih in #8727
- fix: MetadataItem.Source NRE by @yufeih in #8701
- fix: error message typo by @OskarKlintrot in #8713
- fix: --output incorrectly applied to metadata output by @yufeih in #8726
- fix: duplicate seealso divs by @yufeih in #8728
- fix: GetMicrosoftLearnUrl NotSupportedException by @yufeih in #8730
- fix: In page Namespaces keyword disappear by @yufeih in #8739
๐ Documentation
- doc: added basic concepts page by @wilkinson-steve in #8690
New Contributors
- @InFTord made their first contribution in #8700
- @OskarKlintrot made their first contribution in #8713
Full Changelog: v2.66.2...v2.67.0