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

build(deps): Bump DocFxVersion from 2.60.2 to 2.61.0 in /tools/docfx #271

Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 30, 2023

Bumps DocFxVersion from 2.60.2 to 2.61.0.
Updates Microsoft.DocAsCode.Common from 2.60.2 to 2.61.0

Release notes

Sourced from Microsoft.DocAsCode.Common's releases.

v2.61.0

.NET 7.0 and C# 8, 9, 10, 11

This release adds support for .NET 7 and C# 8, 9, 10, 11. Docfx can now generate API docs for .NET 7 projects supporting all the latest C# language features including:

  • Nullable reference types
  • Default interface members
  • Init-only setters
  • Record types
  • Record struct
  • Checked user defined operators
  • Static abstract interface members
  • Required modifier

Display of API names and signatures have been updated to be more idiomatic C#, including but not limited to:

  • Short familiar type names such as string, int
  • ? for nullable structs and () for tuples

Markdown engine and custom markdown extensions

Markdig has been changed to be the default and recommended markdown engine in docfx. At the same time we are deprecating dfm and other markdown engines supported by docfx. Dfm markdown engine would be removed in some future releases.

To use a custom markdown extension in markdig, a ConfigureMarkdig build option is added to customize the markdig markdown pipeline:

var options = new BuildOptions
{
    // Enable custom markdown extensions here
    ConfigureMarkdig = pipeline => pipeline.UseCitations(),
}
await Docset.Build("docfx.json", options);

Client-side redirection

The new redirect_url metadata redirects a page to a new URL. To setup redirection for a markdown article, remove all markdown content and replace it with:

---
redirect_url: <URL to redirect to>
---

Known Issues

  • Default nullable enum values displayed as numbers instead of enums dotnet/roslyn#66514
  • Nullable reference type in the parameters table missing ?.

... (truncated)

Commits
  • 54f1a2f docs: add markdown extension doc and remove dfm docs
  • 59b26d1 feat: remove title from redirection pages
  • 48a4ac5 fix: search indexer incorrectly add space for inline HTML tags
  • 8790fd3 fix: display text over uid for unresolved xref
  • 6458702 feat: display C# special types using familiar format (#8372)
  • f34abfb test: split PDF test from seed
  • 4a87423 docs: add missing docs for force in docfx.exe_user_manual.md (#8377)
  • 31e06ad build: Upgrade to YamlDotNet version 12.3.1 (#8373)
  • 5d569c1 feat: display C# referenced API name using SymbolDisplay (#8374)
  • 310a8d8 [BREAKING CHANGE]: drop builtin fsproj support (#8375)
  • Additional commits viewable in compare view

Updates Microsoft.DocAsCode.MarkdigEngine from 2.60.2 to 2.61.0

Release notes

Sourced from Microsoft.DocAsCode.MarkdigEngine's releases.

v2.61.0

.NET 7.0 and C# 8, 9, 10, 11

This release adds support for .NET 7 and C# 8, 9, 10, 11. Docfx can now generate API docs for .NET 7 projects supporting all the latest C# language features including:

  • Nullable reference types
  • Default interface members
  • Init-only setters
  • Record types
  • Record struct
  • Checked user defined operators
  • Static abstract interface members
  • Required modifier

Display of API names and signatures have been updated to be more idiomatic C#, including but not limited to:

  • Short familiar type names such as string, int
  • ? for nullable structs and () for tuples

Markdown engine and custom markdown extensions

Markdig has been changed to be the default and recommended markdown engine in docfx. At the same time we are deprecating dfm and other markdown engines supported by docfx. Dfm markdown engine would be removed in some future releases.

To use a custom markdown extension in markdig, a ConfigureMarkdig build option is added to customize the markdig markdown pipeline:

var options = new BuildOptions
{
    // Enable custom markdown extensions here
    ConfigureMarkdig = pipeline => pipeline.UseCitations(),
}
await Docset.Build("docfx.json", options);

Client-side redirection

The new redirect_url metadata redirects a page to a new URL. To setup redirection for a markdown article, remove all markdown content and replace it with:

---
redirect_url: <URL to redirect to>
---

Known Issues

  • Default nullable enum values displayed as numbers instead of enums dotnet/roslyn#66514
  • Nullable reference type in the parameters table missing ?.

... (truncated)

Commits
  • 54f1a2f docs: add markdown extension doc and remove dfm docs
  • 59b26d1 feat: remove title from redirection pages
  • 48a4ac5 fix: search indexer incorrectly add space for inline HTML tags
  • 8790fd3 fix: display text over uid for unresolved xref
  • 6458702 feat: display C# special types using familiar format (#8372)
  • f34abfb test: split PDF test from seed
  • 4a87423 docs: add missing docs for force in docfx.exe_user_manual.md (#8377)
  • 31e06ad build: Upgrade to YamlDotNet version 12.3.1 (#8373)
  • 5d569c1 feat: display C# referenced API name using SymbolDisplay (#8374)
  • 310a8d8 [BREAKING CHANGE]: drop builtin fsproj support (#8375)
  • Additional commits viewable in compare view

Updates Microsoft.DocAsCode.Plugins from 2.60.2 to 2.61.0

Release notes

Sourced from Microsoft.DocAsCode.Plugins's releases.

v2.61.0

.NET 7.0 and C# 8, 9, 10, 11

This release adds support for .NET 7 and C# 8, 9, 10, 11. Docfx can now generate API docs for .NET 7 projects supporting all the latest C# language features including:

  • Nullable reference types
  • Default interface members
  • Init-only setters
  • Record types
  • Record struct
  • Checked user defined operators
  • Static abstract interface members
  • Required modifier

Display of API names and signatures have been updated to be more idiomatic C#, including but not limited to:

  • Short familiar type names such as string, int
  • ? for nullable structs and () for tuples

Markdown engine and custom markdown extensions

Markdig has been changed to be the default and recommended markdown engine in docfx. At the same time we are deprecating dfm and other markdown engines supported by docfx. Dfm markdown engine would be removed in some future releases.

To use a custom markdown extension in markdig, a ConfigureMarkdig build option is added to customize the markdig markdown pipeline:

var options = new BuildOptions
{
    // Enable custom markdown extensions here
    ConfigureMarkdig = pipeline => pipeline.UseCitations(),
}
await Docset.Build("docfx.json", options);

Client-side redirection

The new redirect_url metadata redirects a page to a new URL. To setup redirection for a markdown article, remove all markdown content and replace it with:

---
redirect_url: <URL to redirect to>
---

Known Issues

  • Default nullable enum values displayed as numbers instead of enums dotnet/roslyn#66514
  • Nullable reference type in the parameters table missing ?.

... (truncated)

Commits
  • 54f1a2f docs: add markdown extension doc and remove dfm docs
  • 59b26d1 feat: remove title from redirection pages
  • 48a4ac5 fix: search indexer incorrectly add space for inline HTML tags
  • 8790fd3 fix: display text over uid for unresolved xref
  • 6458702 feat: display C# special types using familiar format (#8372)
  • f34abfb test: split PDF test from seed
  • 4a87423 docs: add missing docs for force in docfx.exe_user_manual.md (#8377)
  • 31e06ad build: Upgrade to YamlDotNet version 12.3.1 (#8373)
  • 5d569c1 feat: display C# referenced API name using SymbolDisplay (#8374)
  • 310a8d8 [BREAKING CHANGE]: drop builtin fsproj support (#8375)
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps `DocFxVersion` from 2.60.2 to 2.61.0.

Updates `Microsoft.DocAsCode.Common` from 2.60.2 to 2.61.0
- [Release notes](https://github.com/dotnet/docfx/releases)
- [Changelog](https://github.com/dotnet/docfx/blob/main/RELEASENOTE.md)
- [Commits](dotnet/docfx@v2.60.2...v2.61.0)

Updates `Microsoft.DocAsCode.MarkdigEngine` from 2.60.2 to 2.61.0
- [Release notes](https://github.com/dotnet/docfx/releases)
- [Changelog](https://github.com/dotnet/docfx/blob/main/RELEASENOTE.md)
- [Commits](dotnet/docfx@v2.60.2...v2.61.0)

Updates `Microsoft.DocAsCode.Plugins` from 2.60.2 to 2.61.0
- [Release notes](https://github.com/dotnet/docfx/releases)
- [Changelog](https://github.com/dotnet/docfx/blob/main/RELEASENOTE.md)
- [Commits](dotnet/docfx@v2.60.2...v2.61.0)

---
updated-dependencies:
- dependency-name: Microsoft.DocAsCode.Common
  dependency-type: direct:production
  update-type: version-update:semver-minor
- dependency-name: Microsoft.DocAsCode.MarkdigEngine
  dependency-type: direct:production
  update-type: version-update:semver-minor
- dependency-name: Microsoft.DocAsCode.Plugins
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added .NET Pull requests that update .net code dependencies Pull requests that update a dependency file labels Jan 30, 2023
@notheotherben notheotherben merged commit c1fa12f into main Jan 30, 2023
@notheotherben notheotherben deleted the dependabot/nuget/tools/docfx/DocFxVersion-2.61.0 branch January 30, 2023 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file .NET Pull requests that update .net code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant