Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docfx 2.64.0 #127263

Closed
wants to merge 1 commit into from
Closed

docfx 2.64.0 #127263

wants to merge 1 commit into from

Conversation

BrewTestBot
Copy link
Member

Created by brew bump


Created with brew bump-formula-pr.

release notes

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

🐞 Bug Fixes

📄 Documentation

Full Changelog: dotnet/docfx@v2.63.1...v2.64.0

@github-actions github-actions bot added bump-formula-pr PR was created using `brew bump-formula-pr` dotnet .NET use is a significant feature of the PR or issue labels Apr 1, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Apr 3, 2023

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. To keep this pull request open, add a help wanted or in progress label.

@github-actions github-actions bot added the stale No recent activity label Apr 3, 2023
@github-actions github-actions bot closed this Apr 5, 2023
@p-linnane p-linnane deleted the bump-docfx-2.64.0 branch February 24, 2024 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bump-formula-pr PR was created using `brew bump-formula-pr` dotnet .NET use is a significant feature of the PR or issue stale No recent activity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant