v2.63.0
New Modern Template
This release features a brand new modern
site template based on bootstrap 5 with a lot of visual and usability improvements:
- Supports both dark and light themes
- Match .NET API reference docs with https://learn.microsoft.com
- Usability improvements such as code copy, clickable images, external link icons, better API text breaks, link to GitHub, etc.
The docfx official site has also been updated to use the new template. To use the modern template in your website, set the template to ["default", "modern"]
.
What's Changed
💥 Breaking Changes
🎉 New Features
- feat: new modern template @yufeih in #8470 #8440 #8498 #8515 #8516 #8524
- feat: add dark theme to modern template by @yufeih in #8499 #8512
- feat: adjust .NET API display for modern template by @yufeih in #8525
- feat: show
_appName
after logo by @yufeih in #8438 - feat: add code copy by @yufeih in #8517
- feat: clickable image by @yufeih in #8518
- feat: update docfx to use modern template by @yufeih in #8513
- feat: add tags to word boundaries by @yufeih in #8521
- feat: add icon to external links by @yufeih in #8523
- feat: show TOC node as expanded using the
expanded
property by @yufei in #8498 - feat: Group explicit interface implementations into their own section by @mikernet in #8445
🐞 Bug Fixes
- fix: Newtonsoft.Json.Schema -> JsonSchema.Net by @yufeih in #8418
- fix: incorrect type name for unresolved generic types by @yufeih in #8491
- fix: mref properties inherit parent items by @yufeih in #8492
- fix: custom logo does not override logo from template by @yufeih in #8510 #8522
🔧 Engineering
- build: setup ts/scss/watch by @yufeih in #8421 #8423
- test: add visual snapshot testing by @yufeih in #8422 #8481
- build: upgrade to YamlDotNet 13.0.1 by @lahma in #8442
📄 Documentation
- Add minimal template by @sotanakamura in #8447
- Improvement Document Guideline markdown with image by @chuongmep in #8485
New Contributors
- @sotanakamura made their first contribution in #8447
- @chuongmep made their first contribution in #8485
Full Changelog: v2.62.2...v2.63.0