docfx | Markdown Ecosystem Directory

Bot releases are visible (Hide)

docfx - v2.61.0

Published by yufeih over 1 year ago

.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 https://github.com/dotnet/roslyn/issues/66514
Nullable reference type in the parameters table missing ?.

What's Changed

💥 Breaking Changes

BREAKING CHANGE: Set markdig as default and deprecate dfm. by @yufeih in https://github.com/dotnet/docfx/pull/8342
BREAKING CHANGE: Drop modifiers from .NET API YAML output by @yufeih in https://github.com/dotnet/docfx/pull/8364
BREAKING CHANGE: Drop builtin fsproj support by @yufeih in https://github.com/dotnet/docfx/pull/8375

🎉 New Features

feat: Support building csproj targeting net7.0 by @yufeih in https://github.com/dotnet/docfx/pull/8349
feat: Support redirect_url by @yufeih in https://github.com/dotnet/docfx/pull/8340
feat: Clickable console log by @yufeih in https://github.com/dotnet/docfx/pull/8341
feat: Allow custom markdown extensions by @yufeih in https://github.com/dotnet/docfx/pull/8358
feat: Display C# API using SymbolDisplay by @yufeih in https://github.com/dotnet/docfx/pull/8366 https://github.com/dotnet/docfx/pull/8367 https://github.com/dotnet/docfx/pull/8374
feat: display C# special types using familiar format by @yufeih in https://github.com/dotnet/docfx/pull/8372

🐞 Bug Fixes

fix: Set summary and conceptual to empty string instead of null by @NanoBob in https://github.com/dotnet/docfx/pull/8370

🔧 Engineering

build: Upgrade to Jint 3.0.0-beta-2046 by @lahma in https://github.com/dotnet/docfx/pull/8361
build: Upgrade to YamlDotNet version 12.3.1 by @lahma in https://github.com/dotnet/docfx/pull/8373

📄 Documentation

docs: Corrected typo by @Diagonir in https://github.com/dotnet/docfx/pull/8368
docs: Update docfx.exe_user_manual.md by @zp-zpanda in https://github.com/dotnet/docfx/pull/8377

New Contributors

@lahma made their first contribution in https://github.com/dotnet/docfx/pull/8361
@Diagonir made their first contribution in https://github.com/dotnet/docfx/pull/8368
@NanoBob made their first contribution in https://github.com/dotnet/docfx/pull/8370
@zp-zpanda made their first contribution in https://github.com/dotnet/docfx/pull/8377

Full Changelog: https://github.com/dotnet/docfx/compare/v2.60.0...v2.61.2

docfx - v2.60.2

Published by yufeih almost 2 years ago

What's Changed

🐞 Bug Fixes

fix: wrong NuGet content directory layout (https://github.com/dotnet/docfx/issues/8354)

Full Changelog: https://github.com/dotnet/docfx/compare/v2.60.1...v2.60.2

docfx - v2.60.1

Published by yufeih almost 2 years ago

What's Changed

🐞 Bug Fixes

fix: RunPdf.Exec threw ArgumentNullException resolving path to wkhtmltopdf by @chrisvanderpennen in https://github.com/dotnet/docfx/pull/8350
ci: publish self contained binaries to GitHub releases

New Contributors

@chrisvanderpennen made their first contribution in https://github.com/dotnet/docfx/pull/8350

Full Changelog: https://github.com/dotnet/docfx/compare/v2.60.0...v2.60.1

docfx - Version 2.60.0

Published by yufeih almost 2 years ago

.NET Core Support

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.

What's Changed

🎉 New Features

Go net6.0 by @tibel in https://github.com/dotnet/docfx/pull/8238 https://github.com/dotnet/docfx/pull/8239 https://github.com/dotnet/docfx/pull/8241 https://github.com/dotnet/docfx/pull/8254
feat: Upgrade to .NET Core by @yufeih in https://github.com/dotnet/docfx/pull/8279
ci: Ship as global tool to NuGet.org by @yufeih in https://github.com/dotnet/docfx/pull/8280
fix: Fix serve command by owin -> ASPNET.Core by @yufeih in https://github.com/dotnet/docfx/pull/8293
feat: New extensibility model based on libraries by @yufeih in https://github.com/dotnet/docfx/pull/8306
feat: publish template assets as NuGet contentFiles by @yufeih in https://github.com/dotnet/docfx/pull/8307
feat: drop compilation dependency on .NET Framework by @yufeih in https://github.com/dotnet/docfx/pull/8309
feat: Support MacOS by @yufeih in https://github.com/dotnet/docfx/pull/8310
feat: Support Ubuntu by @yufeih in https://github.com/dotnet/docfx/pull/8311
feat: detect GH action branch name by @yufeih in https://github.com/dotnet/docfx/pull/8314

🐞 Bug Fixes

fix: TOC word-break not being inserted in generic types by @julesabr in https://github.com/dotnet/docfx/pull/8217
fix: Crash fixes for CopyInherited by @Sorpirit in https://github.com/dotnet/docfx/pull/7709
fix: Fix on DocFX crashes on method parameter by @harriev9 in https://github.com/dotnet/docfx/pull/8208

🔧 Engineering

build: Update package references by @tibel in https://github.com/dotnet/docfx/pull/8139
build: Upgrade NuGet.Protocol by @YunshuMeg in https://github.com/dotnet/docfx/pull/8236
build: Upgrade Newtonsoft.Json from 13.0.1 to 13.0.2 by @YunshuMeg in https://github.com/dotnet/docfx/pull/8257
test: Add samples and snapshot testing by @yufeih in https://github.com/dotnet/docfx/pull/8299
build: Remove old package references by @tibel in https://github.com/dotnet/docfx/pull/8318

📄 Documentation

docs: Product docs rework for new release by @yufeih in https://github.com/dotnet/docfx/pull/8332
docs: Fix typo by @Lulalaby in https://github.com/dotnet/docfx/pull/8252
docs: Update issue templates by @yufeih in https://github.com/dotnet/docfx/pull/8294

New Contributors

@julesabr made their first contribution in https://github.com/dotnet/docfx/pull/8217
@Sorpirit made their first contribution in https://github.com/dotnet/docfx/pull/7709
@harriev9 made their first contribution in https://github.com/dotnet/docfx/pull/8208
@Lulalaby made their first contribution in https://github.com/dotnet/docfx/pull/8252

Full Changelog: https://github.com/dotnet/docfx/compare/v2.59.4...v2.60.0

docfx - Version 2.60.0-preview.2

Published by yufeih almost 2 years ago

What's Changed

Addresses all known limitations in v2.60.0-preview.1:

.NET Core: Support generating APIs from source code, csproj, DLLs without installing .NET Framework.
Cross platform: Support Windows, Linux and MacOS
New Extensibility Model: 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.

🎉 New Features

feat: New extensibility model based on libraries by @yufeih in https://github.com/dotnet/docfx/pull/8306
feat: publish template assets as NuGet contentFiles by @yufeih in https://github.com/dotnet/docfx/pull/8307
feat: drop compilation dependency on .NET Framework by @yufeih in https://github.com/dotnet/docfx/pull/8309
feat: Support MacOS by @yufeih in https://github.com/dotnet/docfx/pull/8310
feat: Support Ubuntu by @yufeih in https://github.com/dotnet/docfx/pull/8311

Full Changelog: https://github.com/dotnet/docfx/compare/v2.60.0-preview.1...v2.60.0-preview.2

docfx - Version 2.60.0-preview.1

Published by yufeih almost 2 years ago

.NET Core Support

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.

Known Limitations

Msbuild integration through docfx.console is not supported in this preview.
Plugins like memberpage, rest.tagpage, rest.operationpage are not supported in this preview.
Supports Windows only. Linux and MacOS are not supported in this preview.
.NET Framework 4.x is still needed to build from source code in this preview.

What's Changed

🎉 New Features

feat: Go net6.0 by @tibel in https://github.com/dotnet/docfx/pull/8238 https://github.com/dotnet/docfx/pull/8239 https://github.com/dotnet/docfx/pull/8241 https://github.com/dotnet/docfx/pull/8254
feat: Upgrade to .NET Core by @yufeih in https://github.com/dotnet/docfx/pull/8279
feat: Ship as global tool to NuGet.org by @yufeih in https://github.com/dotnet/docfx/pull/8280
feat: Serve command using ASPNET.Core by @yufeih in https://github.com/dotnet/docfx/pull/8293
feat: Deterministic output by @yufeih in https://github.com/dotnet/docfx/pull/8299

🐞 Bug Fixes

fix: TOC word-break not being inserted in generic types by @julesabr in https://github.com/dotnet/docfx/pull/8217
fix: Crash fixes for CopyInherited by @Sorpirit in https://github.com/dotnet/docfx/pull/7709
fix: Fix on DocFX crashes on method parameter by @harriev9 in https://github.com/dotnet/docfx/pull/8208

🔧 Engineering

build: Update package references by @tibel in https://github.com/dotnet/docfx/pull/8139
build: Upgrade NuGet.Protocol by @YunshuMeg in https://github.com/dotnet/docfx/pull/8236
build: Upgrade Newtonsoft.Json from 13.0.1 to 13.0.2 by @YunshuMeg in https://github.com/dotnet/docfx/pull/8257
test: Add samples and snapshot testing by @yufeih in https://github.com/dotnet/docfx/pull/8299

📄 Documentation

docs: Fix typo by @Lulalaby in https://github.com/dotnet/docfx/pull/8252
docs: Update issue templates by @yufeih in https://github.com/dotnet/docfx/pull/8294