Microsoft.DocAsCode.Dfm 2.62.1

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Microsoft.DocAsCode.Dfm --version 2.62.1                
NuGet\Install-Package Microsoft.DocAsCode.Dfm -Version 2.62.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.DocAsCode.Dfm" Version="2.62.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.DocAsCode.Dfm --version 2.62.1                
#r "nuget: Microsoft.DocAsCode.Dfm, 2.62.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.DocAsCode.Dfm as a Cake Addin
#addin nuget:?package=Microsoft.DocAsCode.Dfm&version=2.62.1

// Install Microsoft.DocAsCode.Dfm as a Cake Tool
#tool nuget:?package=Microsoft.DocAsCode.Dfm&version=2.62.1                

Build your docs with docfx

NuGet Help Wanted Gitter

Build your technical documentation site with docfx, with landing pages, markdown, API reference docs for .NET, REST API and more.

⚠️⚠️⚠️ NOTICE ⚠️⚠️⚠️

Getting Started

  1. Install docfx as a global tool:

    dotnet tool install -g docfx
    
  2. Create and start a website locally:

    docfx init -q
    docfx docfx_project\docfx.json --serve
    
  3. Go to https://localhost:8080 to see the sample site.

For more information, refer to Getting Started.

Contributing

Use Discussions for questions and general discussions. Use Issues to report bugs and proposing features.

We welcome code contributions through pull requests, issues tagged as help-wanted are good candidate to start contributing code.

Prerequisites

Build and Test

  • Build site templates in templates directory:
    • Run npm install to restore npm dependencies.
    • Run npm run build to build the templates.
  • Run dotnet build to build the project or use Visual Studio to build docfx.sln.
  • Run dotnet test to test the project or use Visual Studio test explorer.

Branch and Release

The main branch is the default branch for pull requests and most other development activities. We occationally use feature/* branches for epic feature development.

Releases are based on a stable main branch commit using GitHub Releases. Release versioning follows Semantic Versioning. Use of Conventional Commit is encouraged.

Docfx is not released under a regular cadence, new versions arrive when maintainers see enough changes that warrant a new releases. Sometimes we use prereleases to dogfood breaking changes and get feedbacks from the community.

Roadmap

We use Milestones to communicate upcoming changes docfx:

  • Working Set are features being actively worked on. Not every features in this bucket will be committed in the next release but they reflect top of minds of maintainers in the upcoming period.

  • Backlog is a set of feature candidates for some future releases, but are not being actively worked on.

.NET Foundation

This project is supported by the .NET Foundation.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

License

This project is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on Microsoft.DocAsCode.Dfm:

Package Downloads
Microsoft.DocAsCode.AzureMarkdownRewriters

Microsoft.DocAsCode.AzureMarkdownRewriters

Microsoft.DocAsCode.Build.MergeOverwrite

Package Description

Microsoft.DocAsCode.MarkdigMarkdownRewriters

Package Description

JeremyTCD.DocFx.Plugins.MimoMarkdown

A DocFx markdown rendering plugin. MimoMarkdown renders markdown specific to the Mimo documentation/blog theme.

JeremyTCD.DocFx.Plugins

Package Description

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Microsoft.DocAsCode.Dfm:

Repository Stars
apache/lucenenet
Apache Lucene.NET
Version Downloads Last updated
2.63.1 4,357 3/21/2023 2.63.1 is deprecated because it is no longer maintained.
2.63.0 823 3/20/2023 2.63.0 is deprecated because it is no longer maintained.
2.62.2 1,008 3/7/2023 2.62.2 is deprecated because it is no longer maintained.
2.62.1 2,395 2/15/2023 2.62.1 is deprecated because it is no longer maintained.
2.62.0 850 2/14/2023 2.62.0 is deprecated because it is no longer maintained.
2.61.0 2,973 1/30/2023 2.61.0 is deprecated because it is no longer maintained.
2.60.2 1,478 1/20/2023 2.60.2 is deprecated because it is no longer maintained.
2.60.1 1,023 1/18/2023 2.60.1 is deprecated because it is no longer maintained.
2.60.0 1,559 1/13/2023 2.60.0 is deprecated because it is no longer maintained.
2.60.0-preview.2 157 12/25/2022 2.60.0-preview.2 is deprecated because it is no longer maintained.
2.60.0-preview.1 147 12/20/2022 2.60.0-preview.1 is deprecated because it is no longer maintained.
2.59.4 13,190 9/7/2022 2.59.4 is deprecated because it is no longer maintained.
2.59.3 2,263 7/6/2022 2.59.3 is deprecated because it is no longer maintained.
2.59.2 5,314 4/11/2022 2.59.2 is deprecated because it is no longer maintained.
2.59.1 1,537 3/31/2022 2.59.1 is deprecated because it is no longer maintained.
2.59.0 4,025 1/19/2022 2.59.0 is deprecated because it is no longer maintained.
2.58.9 944 11/4/2021 2.58.9 is deprecated because it is no longer maintained.
2.58.8 583 11/1/2021 2.58.8 is deprecated because it is no longer maintained.
2.58.5 581 10/26/2021 2.58.5 is deprecated because it is no longer maintained.
2.58.4 3,969 9/14/2021 2.58.4 is deprecated because it is no longer maintained.
2.58.3 589 9/7/2021 2.58.3 is deprecated because it is no longer maintained.
2.58.2 598 8/24/2021 2.58.2 is deprecated because it is no longer maintained.
2.58.1 580 8/23/2021 2.58.1 is deprecated because it is no longer maintained.
2.58.0 1,671 6/9/2021 2.58.0 is deprecated because it is no longer maintained.
2.57.2 827 4/14/2021 2.57.2 is deprecated because it is no longer maintained.
2.57.1 666 4/13/2021 2.57.1 is deprecated because it is no longer maintained.
2.57.0 661 4/9/2021 2.57.0 is deprecated because it is no longer maintained.
2.56.7 1,791 3/2/2021 2.56.7 is deprecated because it is no longer maintained.
2.56.6 1,551 12/10/2020 2.56.6 is deprecated because it is no longer maintained.
2.56.5 948 11/10/2020 2.56.5 is deprecated because it is no longer maintained.
2.56.4 2,810 10/20/2020 2.56.4 is deprecated because it is no longer maintained.
2.56.3 740 10/12/2020 2.56.3 is deprecated because it is no longer maintained.
2.56.2 1,233 7/27/2020 2.56.2 is deprecated because it is no longer maintained.
2.56.1 896 7/6/2020 2.56.1 is deprecated because it is no longer maintained.
2.56.0 825 6/29/2020 2.56.0 is deprecated because it is no longer maintained.
2.55.0 947 6/12/2020 2.55.0 is deprecated because it is no longer maintained.
2.53.1 1,082 5/11/2020 2.53.1 is deprecated because it is no longer maintained.
2.52.0 1,481 4/13/2020 2.52.0 is deprecated because it is no longer maintained.
2.51.0 3,081 3/20/2020 2.51.0 is deprecated because it is no longer maintained.
2.50.0 1,088 3/2/2020 2.50.0 is deprecated because it is no longer maintained.
2.49.0 864 2/17/2020 2.49.0 is deprecated because it is no longer maintained.
2.48.1 3,300 1/13/2020 2.48.1 is deprecated because it is no longer maintained.
2.48.0 1,853 12/9/2019 2.48.0 is deprecated because it is no longer maintained.
2.47.0 23,598 10/31/2019 2.47.0 is deprecated because it is no longer maintained.
2.46.0 1,362 10/14/2019 2.46.0 is deprecated because it is no longer maintained.
2.45.1 3,081 9/15/2019 2.45.1 is deprecated because it is no longer maintained.
2.45.0 1,173 8/25/2019 2.45.0 is deprecated because it is no longer maintained.
2.44.0 1,894 8/2/2019 2.44.0 is deprecated because it is no longer maintained.
2.43.2 2,064 7/2/2019 2.43.2 is deprecated because it is no longer maintained.
2.43.1 1,194 6/14/2019 2.43.1 is deprecated because it is no longer maintained.
2.42.4 2,001 5/24/2019 2.42.4 is deprecated because it is no longer maintained.
2.42.3 13,369 5/21/2019 2.42.3 is deprecated because it is no longer maintained.
2.42.2 972 5/10/2019 2.42.2 is deprecated because it is no longer maintained.
2.42.0 1,014 4/22/2019 2.42.0 is deprecated because it is no longer maintained.
2.41.0 3,130 3/29/2019 2.41.0 is deprecated because it is no longer maintained.
2.40.12 1,074 3/11/2019 2.40.12 is deprecated because it is no longer maintained.
2.40.11 2,384 2/16/2019 2.40.11 is deprecated because it is no longer maintained.
2.40.10 1,262 2/1/2019 2.40.10 is deprecated because it is no longer maintained.
2.40.9 1,221 1/31/2019 2.40.9 is deprecated because it is no longer maintained.
2.40.8 1,206 1/25/2019 2.40.8 is deprecated because it is no longer maintained.
2.40.7 1,167 1/4/2019 2.40.7 is deprecated because it is no longer maintained.
2.40.5 1,244 12/19/2018 2.40.5 is deprecated because it is no longer maintained.
2.40.4 1,225 11/26/2018 2.40.4 is deprecated because it is no longer maintained.
2.40.2 1,663 11/7/2018 2.40.2 is deprecated because it is no longer maintained.
2.40.1 1,121 10/29/2018 2.40.1 is deprecated because it is no longer maintained.
2.40.0 1,195 10/12/2018 2.40.0 is deprecated because it is no longer maintained.
2.39.2 2,668 9/9/2018 2.39.2 is deprecated because it is no longer maintained.
2.39.1 2,601 9/4/2018 2.39.1 is deprecated because it is no longer maintained.
2.39.0 5,807 9/2/2018 2.39.0 is deprecated because it is no longer maintained.
2.38.1 5,956 8/16/2018 2.38.1 is deprecated because it is no longer maintained.
2.38.0 1,384 8/13/2018 2.38.0 is deprecated because it is no longer maintained.
2.37.2 1,331 7/31/2018 2.37.2 is deprecated because it is no longer maintained.
2.37.1 1,519 7/31/2018 2.37.1 is deprecated because it is no longer maintained.
2.36.2 1,580 6/13/2018 2.36.2 is deprecated because it is no longer maintained.
2.36.1 1,389 5/25/2018 2.36.1 is deprecated because it is no longer maintained.
2.36.0 1,443 5/21/2018 2.36.0 is deprecated because it is no longer maintained.
2.36.0-alpha-0159-g25e5900b4 1,023 4/26/2018 2.36.0-alpha-0159-g25e5900b4 is deprecated because it is no longer maintained.
2.35.4 1,539 5/2/2018 2.35.4 is deprecated because it is no longer maintained.
2.35.3 1,485 5/2/2018 2.35.3 is deprecated because it is no longer maintained.
2.35.0-alpha-0153-g6da267dd4 882 4/25/2018 2.35.0-alpha-0153-g6da267dd4 is deprecated because it is no longer maintained.
2.33.2 27,143 4/3/2018 2.33.2 is deprecated because it is no longer maintained.
2.33.1 1,276 4/3/2018 2.33.1 is deprecated because it is no longer maintained.
2.33.0 1,428 3/19/2018 2.33.0 is deprecated because it is no longer maintained.
2.32.2 1,485 3/12/2018 2.32.2 is deprecated because it is no longer maintained.
2.32.0 1,458 2/28/2018 2.32.0 is deprecated because it is no longer maintained.
2.31.0 1,522 2/5/2018 2.31.0 is deprecated because it is no longer maintained.
2.30.0 1,448 1/12/2018 2.30.0 is deprecated because it is no longer maintained.
2.29.1 1,560 12/29/2017 2.29.1 is deprecated because it is no longer maintained.
2.28.3 1,339 12/14/2017 2.28.3 is deprecated because it is no longer maintained.
2.28.2 1,302 12/7/2017 2.28.2 is deprecated because it is no longer maintained.
2.28.1 1,425 12/1/2017 2.28.1 is deprecated because it is no longer maintained.
2.28.0 1,408 11/30/2017 2.28.0 is deprecated because it is no longer maintained.
2.27.0 1,372 11/21/2017 2.27.0 is deprecated because it is no longer maintained.
2.26.3 1,468 10/26/2017 2.26.3 is deprecated because it is no longer maintained.
2.26.1 1,314 10/24/2017 2.26.1 is deprecated because it is no longer maintained.
2.26.0 1,234 10/23/2017 2.26.0 is deprecated because it is no longer maintained.
2.25.1 1,315 10/9/2017 2.25.1 is deprecated because it is no longer maintained.
2.25.0 1,510 10/9/2017 2.25.0 is deprecated because it is no longer maintained.
2.24.0 6,167 9/11/2017 2.24.0 is deprecated because it is no longer maintained.
2.23.1 1,282 8/22/2017 2.23.1 is deprecated because it is no longer maintained.
2.22.3 1,362 8/17/2017 2.22.3 is deprecated because it is no longer maintained.
2.22.1 1,478 8/2/2017 2.22.1 is deprecated because it is no longer maintained.
2.22.0 1,355 8/1/2017 2.22.0 is deprecated because it is no longer maintained.
2.21.2 1,294 7/26/2017 2.21.2 is deprecated because it is no longer maintained.
2.21.1 1,376 7/17/2017 2.21.1 is deprecated because it is no longer maintained.
2.20.0 1,370 7/12/2017 2.20.0 is deprecated because it is no longer maintained.
2.19.2 1,440 6/29/2017 2.19.2 is deprecated because it is no longer maintained.
2.18.5 1,391 6/15/2017 2.18.5 is deprecated because it is no longer maintained.
2.18.4 1,395 6/9/2017 2.18.4 is deprecated because it is no longer maintained.
2.18.3 1,406 6/8/2017 2.18.3 is deprecated because it is no longer maintained.
2.18.1 1,263 5/31/2017 2.18.1 is deprecated because it is no longer maintained.
2.17.5 1,239 5/23/2017 2.17.5 is deprecated because it is no longer maintained.
2.17.3 1,455 5/11/2017 2.17.3 is deprecated because it is no longer maintained.
2.17.2 1,247 5/9/2017 2.17.2 is deprecated because it is no longer maintained.
2.16.8 1,199 5/3/2017 2.16.8 is deprecated because it is no longer maintained.
2.16.7 1,259 4/26/2017 2.16.7 is deprecated because it is no longer maintained.
2.16.5 1,207 4/25/2017 2.16.5 is deprecated because it is no longer maintained.
2.16.2 1,196 4/20/2017 2.16.2 is deprecated because it is no longer maintained.
2.16.0 1,228 4/17/2017 2.16.0 is deprecated because it is no longer maintained.
2.15.5 1,857 4/6/2017 2.15.5 is deprecated because it is no longer maintained.
2.15.2 1,904 3/29/2017 2.15.2 is deprecated because it is no longer maintained.
2.13.1 1,821 3/7/2017 2.13.1 is deprecated because it is no longer maintained.
2.13.0 1,815 3/6/2017 2.13.0 is deprecated because it is no longer maintained.
2.12.1 1,958 2/14/2017 2.12.1 is deprecated because it is no longer maintained.
2.12.0 1,848 2/13/2017 2.12.0 is deprecated because it is no longer maintained.
2.11.3 1,716 2/7/2017 2.11.3 is deprecated because it is no longer maintained.
2.11.2 1,690 1/25/2017 2.11.2 is deprecated because it is no longer maintained.
2.11.1 1,770 1/24/2017 2.11.1 is deprecated because it is no longer maintained.
2.11.0 1,780 1/23/2017 2.11.0 is deprecated because it is no longer maintained.
2.10.2 1,787 1/4/2017 2.10.2 is deprecated because it is no longer maintained.
2.10.1 1,879 1/4/2017 2.10.1 is deprecated because it is no longer maintained.
2.10.0 2,054 1/3/2017 2.10.0 is deprecated because it is no longer maintained.
2.9.3 1,709 12/15/2016 2.9.3 is deprecated because it is no longer maintained.
2.9.2 1,729 12/14/2016 2.9.2 is deprecated because it is no longer maintained.
2.9.1 1,653 12/13/2016 2.9.1 is deprecated because it is no longer maintained.
2.9.0 1,672 12/12/2016 2.9.0 is deprecated because it is no longer maintained.
2.8.2 1,784 11/28/2016 2.8.2 is deprecated because it is no longer maintained.
2.8.1 1,808 11/24/2016 2.8.1 is deprecated because it is no longer maintained.
2.8.0 1,988 11/22/2016 2.8.0 is deprecated because it is no longer maintained.
2.7.3 2,085 11/8/2016 2.7.3 is deprecated because it is no longer maintained.
2.7.2 1,931 11/3/2016 2.7.2 is deprecated because it is no longer maintained.
2.7.1 2,013 11/1/2016 2.7.1 is deprecated because it is no longer maintained.
2.7.0 1,831 10/31/2016 2.7.0 is deprecated because it is no longer maintained.
2.6.3 1,794 10/25/2016 2.6.3 is deprecated because it is no longer maintained.
2.6.1 1,742 10/11/2016 2.6.1 is deprecated because it is no longer maintained.
2.6.0 1,790 10/10/2016 2.6.0 is deprecated because it is no longer maintained.
2.5.4 2,220 9/22/2016 2.5.4 is deprecated because it is no longer maintained.
2.5.3 2,083 9/20/2016 2.5.3 is deprecated because it is no longer maintained.
2.5.2 1,911 9/19/2016 2.5.2 is deprecated because it is no longer maintained.
2.5.1 1,945 9/19/2016 2.5.1 is deprecated because it is no longer maintained.
2.5.0 1,788 9/14/2016 2.5.0 is deprecated because it is no longer maintained.
2.4.0 1,562 8/29/2016 2.4.0 is deprecated because it is no longer maintained.
2.3.1 1,291 8/22/2016 2.3.1 is deprecated because it is no longer maintained.
2.3.0 1,464 8/8/2016 2.3.0 is deprecated because it is no longer maintained.
2.2.2 1,408 7/22/2016 2.2.2 is deprecated because it is no longer maintained.
2.2.1 1,386 7/19/2016 2.2.1 is deprecated because it is no longer maintained.
2.2.0 1,362 7/18/2016 2.2.0 is deprecated because it is no longer maintained.
2.1.0 1,501 6/27/2016 2.1.0 is deprecated because it is no longer maintained.
2.0.2 1,340 6/22/2016 2.0.2 is deprecated because it is no longer maintained.
2.0.1 1,423 6/7/2016 2.0.1 is deprecated because it is no longer maintained.
2.0.0 1,337 6/6/2016 2.0.0 is deprecated because it is no longer maintained.
1.9.4 1,566 5/19/2016 1.9.4 is deprecated because it is no longer maintained.
1.9.3 1,333 5/19/2016 1.9.3 is deprecated because it is no longer maintained.
1.9.0 1,334 5/16/2016 1.9.0 is deprecated because it is no longer maintained.
1.8.4 1,337 5/10/2016 1.8.4 is deprecated because it is no longer maintained.
1.8.1 1,394 5/4/2016 1.8.1 is deprecated because it is no longer maintained.
1.8.0 1,607 4/25/2016 1.8.0 is deprecated because it is no longer maintained.
1.7.2 1,339 4/20/2016 1.7.2 is deprecated because it is no longer maintained.
1.7.1 1,360 4/7/2016 1.7.1 is deprecated because it is no longer maintained.
1.7.0 1,428 4/6/2016 1.7.0 is deprecated because it is no longer maintained.
1.6.1 1,332 3/16/2016 1.6.1 is deprecated because it is no longer maintained.
1.5.0 1,511 2/22/2016 1.5.0 is deprecated because it is no longer maintained.
1.4.2 1,376 2/3/2016 1.4.2 is deprecated because it is no longer maintained.
1.4.1 1,279 2/2/2016 1.4.1 is deprecated because it is no longer maintained.
1.4.0 1,258 2/1/2016 1.4.0 is deprecated because it is no longer maintained.
1.3.7 1,338 1/21/2016 1.3.7 is deprecated because it is no longer maintained.
1.3.5 1,365 1/13/2016 1.3.5 is deprecated because it is no longer maintained.
1.3.3 1,468 1/13/2016 1.3.3 is deprecated because it is no longer maintained.
1.3.0 1,481 1/11/2016 1.3.0 is deprecated because it is no longer maintained.