Skip to content

Releases: dotnet/docfx

v2.66.0

24 Apr 04:04
@yufeih yufeih
v2.66.0
b028406
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.66.0

What's Changed

🎉 New Features

🐞 Bug Fixes

📄 Documentation

New Contributors

Full Changelog: v2.65.3...v2.66.0

Contributors

yufeih, VaclavElias, and 2 other contributors
Assets 5
Loading

v2.65.3

14 Apr 13:14
@yufeih yufeih
v2.65.3
f26146a
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.65.3

What's Changed

🐞 Bug Fixes

📄 Documentation

New Contributors

Full Changelog: v2.65.2...v2.65.3

Contributors

yufeih and wilkinson-steve
Assets 5
Loading

v2.65.2

11 Apr 08:17
@yufeih yufeih
v2.65.2
85235a2
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.65.2

What's Changed

🎉 New Features

  • feat: calculate internal cross-reference URL without xrefmap by @yufeih in #8588
  • feat: show previous next article link by @yufeih in #8614
  • feat: support name only TOC node by @yufeih in #8624
  • feat: move modern template icons location to menu bar by @yufeih in #8613

📄 Documentation

Full Changelog: 2.65.1...v2.65.2

Contributors

yufeih and VaclavElias
Assets 5
Loading

v2.65.1

09 Apr 09:55
@yufeih yufeih
2.65.1
dcc61b8
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.65.1

What's Changed

🐞 Bug Fixes

📄 Documentation

New Contributors

Full Changelog: v2.65.0...2.65.1

Contributors

yufeih and VaclavElias
Assets 5
Loading

v2.65.0

07 Apr 00:19
@yufeih yufeih
v2.65.0
4551e4e
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.65.0

Enhanced <inheritdoc /> support

The <inheritdoc /> tag for C# documentation comments now behaves more like Visual Studio and Visual Studio Code. Members automatically inherit documentation from their base class or interfaces, including base class library types. Additionally, you can use the cref and path attributes to customize the behavior of <inheritdoc />.

Mermaid Diagrams in markdown

You can now create Mermaid diagrams using markdown code blocks. Here's a simple example:

```mermaid
flowchart LR
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
```

LaTeX Math Expression in markdown

Incorporate LaTeX math expressions in your documentation using the $ or $$ delimiter. For instance:

$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$

What's Changed

💥 Breaking Changes

🎉 New Features

💪 Other Changes

Full Changelog: v2.64.0...v2.65.0

Contributors

yufeih
Assets 5
Loading
0 Join discussion

v2.64.0

30 Mar 05:30
@yufeih yufeih
v2.64.0
6a1e6d7
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.64.0

C# documentation comment link enhancements

This release improves link generation for C# documentation comment in a couple of areas:

  • Links to base class libraries are generated automatically without using the xref service or extra config. This is done by calculating the references to APIs hosted on https://learn.microsoft.com/dotnet/api using an URL pattern offline.
  • View source is now available for assemblies as input if
    • The assembly enables SourceLink
    • A PDB file exist next to the assembly file.
  • Links to types in dependency assemblies produces URLs pointing to the API source code location if:
    • The dependency assembly enables SourceLink
    • A PDB file exist next to the assembly file.
  • <see langword=""> now properly resolves to URLs pointing to https://learn.microsoft.com.

MemberPage as a first class feature

The memberpage plugin is now replaced by a first-class feature using the experimental { "memberLayout": "SeparatePages" } config. See this example on how to enable the behavior in docfx.json.

NOTE: This new feature has been manually tested for the default templates, the modern template and the statictoc template, but there might be glitches in some edge cases.

Sunset DFM markdown engine

The MarkdownLite and DFM markdown engine is removed from docfx in this release. DFM users are encouraged to update to markdig for a commonmark compliant markdown parser, a rich markdown extension eco-system and better performance.

What's Changed

💥 Breaking Changes

🎉 New Features

  • feat: compute mslearn symbol URL by @yufeih in #8546
  • feat: view source for assemblies using sourcelink by @yufeih in #8548
  • feat: resolve langword to URLs by @yufeih in #8550
  • feat: add allowCompilationErrors option by @yufeih in #8554
  • feat: memberpage plugin -> memberLayout.SeparatePages by @yufeih in #8569

🐞 Bug Fixes

📄 Documentation

Full Changelog: v2.63.1...v2.64.0

Contributors

yufeih and mtirionMSFT
Assets 5
Loading
0 Join discussion

v2.63.1

21 Mar 07:49
@yufeih yufeih
v2.63.1
dd61c7a
Compare
Choose a tag to compare
v2.63.1

What's Changed

🎉 New Features

🔧 Engineering

  • Fix warnings and consolidate Directory.build.props by @RussKie in #8536

New Contributors

Full Changelog: v2.63.0...v2.63.1

Contributors

RussKie
Assets 5
Loading

v2.63.0

20 Mar 05:38
@yufeih yufeih
v2.63.0
9a8a2ab
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
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

  • BREAKING CHANGE: drop support of liquid template by @yufeih in #8437

🎉 New Features

🐞 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

📄 Documentation

New Contributors

Full Changelog: v2.62.2...v2.63.0

Contributors

yufei, lahma, and 4 other contributors
Assets 5
Loading

v2.62.2

07 Mar 00:53
@yufeih yufeih
v2.62.2
50e87b1
Compare
Choose a tag to compare
v2.62.2

What's Changed

🐞 Bug Fixes

Full Changelog: v2.62.1...v2.62.2

Contributors

yufeih and NanoBob
Assets 5
Loading

v2.62.1

15 Feb 12:12
@yufeih yufeih
v2.62.1
8252e5b
Compare
Choose a tag to compare
v2.62.1

What's Changed

🐞 Bug Fixes

  • fix: cannot search due to lunr not defined by @yufeih in #8416

Full Changelog: v2.62.0...v2.62.1

Contributors

yufeih
Assets 5
Loading