Static site generator for .NET API documentation.
MIT License
Bot releases are visible (Hide)
Published by yufeih over 1 year ago
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:
Display of API names and signatures have been updated to be more idiomatic C#, including but not limited to:
string
, int
?
for nullable structs and ()
for tuplesMarkdig 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);
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>
---
?
.Full Changelog: https://github.com/dotnet/docfx/compare/v2.60.0...v2.61.2
Published by yufeih almost 2 years ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.60.1...v2.60.2
Published by yufeih almost 2 years ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.60.0...v2.60.1
Published by yufeih almost 2 years ago
This is the first stable release of docfx on .NET Core!
Docfx is released as a .NET Core Tool starting from v2.60.0
. To install, run:
dotnet tool update -g docfx
The rest of the command line experience hasn't changed and are backward compatible. We've also updated docfx homepage use the .NET Core version of docfx.
Full Changelog: https://github.com/dotnet/docfx/compare/v2.59.4...v2.60.0
Published by yufeih almost 2 years ago
Addresses all known limitations in v2.60.0-preview.1:
docfx.console
and plugins are replaced with a new compile time extensibility model. To consume docfx as a library or use docfx extensions, add reference to the Microsoft.DocAsCode.App
package. See samples/extensions
folder on a sample using the memberpage
plugin.Full Changelog: https://github.com/dotnet/docfx/compare/v2.60.0-preview.1...v2.60.0-preview.2
Published by yufeih almost 2 years ago
This is the first preview of docfx that builds on top of .NET Core!
Docfx is released as a .NET Core Tool starting from v2.60.0-preview.1
. .NET 6.x is required to run docfx. To install, run:
dotnet tool update -g docfx --version 2.60.0-preview.1
The rest of the command line experience hasn't changed and are backward compatible. We've also updated docfx homepage use the .NET Core version of docfx.
docfx.console
is not supported in this preview.memberpage
, rest.tagpage
, rest.operationpage
are not supported in this preview.Full Changelog: https://github.com/dotnet/docfx/compare/v2.59.4...v2.60.0-preview.1
Published by github-actions[bot] about 2 years ago
Published by github-actions[bot] about 2 years ago
Published by github-actions[bot] about 2 years ago
Published by github-actions[bot] about 2 years ago
Published by github-actions[bot] about 2 years ago
Published by opbld49 about 2 years ago
Published by github-actions[bot] about 2 years ago
Published by github-actions[bot] about 2 years ago
Published by github-actions[bot] about 2 years ago
Published by github-actions[bot] over 2 years ago
Published by opbld49 over 2 years ago
Published by github-actions[bot] over 2 years ago
Published by github-actions[bot] over 2 years ago
Published by github-actions[bot] over 2 years ago