Microsoft.DocAsCode.Dfm 2.63.1

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0 
dotnet add package Microsoft.DocAsCode.Dfm --version 2.63.1
NuGet\Install-Package Microsoft.DocAsCode.Dfm -Version 2.63.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.63.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.63.1
#r "nuget: Microsoft.DocAsCode.Dfm, 2.63.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.63.1

// Install Microsoft.DocAsCode.Dfm as a Cake Tool
#tool nuget:?package=Microsoft.DocAsCode.Dfm&version=2.63.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.
    • Run git lfs checkout to checkout files for snapshot testing

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. 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 is compatible.  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 The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Microsoft.DocAsCode.AzureMarkdownRewriters
Microsoft.DocAsCode.Build.MergeOverwrite The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Package Description
Microsoft.DocAsCode.MarkdigMarkdownRewriters The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

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,221 3/21/2023
2.63.0 763 3/20/2023
2.62.2 944 3/7/2023
2.62.1 2,300 2/15/2023
2.62.0 785 2/14/2023
2.61.0 2,885 1/30/2023
2.60.2 1,395 1/20/2023
2.60.1 945 1/18/2023
2.60.0 1,434 1/13/2023
2.60.0-preview.2 135 12/25/2022
2.60.0-preview.1 124 12/20/2022
2.59.4 11,417 9/7/2022
2.59.3 2,185 7/6/2022
2.59.2 5,232 4/11/2022
2.59.1 1,485 3/31/2022
2.59.0 3,164 1/19/2022
2.58.9 894 11/4/2021
2.58.8 544 11/1/2021
2.58.5 537 10/26/2021
2.58.4 3,735 9/14/2021
2.58.3 551 9/7/2021
2.58.2 561 8/24/2021
2.58.1 540 8/23/2021
2.58.0 1,465 6/9/2021
2.57.2 783 4/14/2021
2.57.1 607 4/13/2021
2.57.0 626 4/9/2021
2.56.7 1,754 3/2/2021
2.56.6 1,521 12/10/2020
2.56.5 894 11/10/2020
2.56.4 2,591 10/20/2020
2.56.3 712 10/12/2020
2.56.2 1,167 7/27/2020
2.56.1 867 7/6/2020
2.56.0 782 6/29/2020
2.55.0 909 6/12/2020
2.53.1 1,034 5/11/2020
2.52.0 1,440 4/13/2020
2.51.0 3,041 3/20/2020
2.50.0 1,041 3/2/2020
2.49.0 839 2/17/2020
2.48.1 3,186 1/13/2020
2.48.0 1,799 12/9/2019
2.47.0 23,554 10/31/2019
2.46.0 1,336 10/14/2019
2.45.1 3,030 9/15/2019
2.45.0 1,144 8/25/2019
2.44.0 1,861 8/2/2019
2.43.2 2,030 7/2/2019
2.43.1 1,168 6/14/2019
2.42.4 1,951 5/24/2019
2.42.3 13,339 5/21/2019
2.42.2 941 5/10/2019
2.42.0 990 4/22/2019
2.41.0 3,104 3/29/2019
2.40.12 1,031 3/11/2019
2.40.11 2,356 2/16/2019
2.40.10 1,233 2/1/2019
2.40.9 1,195 1/31/2019
2.40.8 1,182 1/25/2019
2.40.7 1,141 1/4/2019
2.40.5 1,202 12/19/2018
2.40.4 1,186 11/26/2018
2.40.2 1,607 11/7/2018
2.40.1 1,097 10/29/2018
2.40.0 1,156 10/12/2018
2.39.2 2,640 9/9/2018
2.39.1 2,577 9/4/2018
2.39.0 5,759 9/2/2018
2.38.1 5,918 8/16/2018
2.38.0 1,358 8/13/2018
2.37.2 1,280 7/31/2018
2.37.1 1,488 7/31/2018
2.36.2 1,548 6/13/2018
2.36.1 1,365 5/25/2018
2.36.0 1,413 5/21/2018
2.36.0-alpha-0159-g25e5900b4 961 4/26/2018
2.35.4 1,484 5/2/2018
2.35.3 1,421 5/2/2018
2.35.0-alpha-0153-g6da267dd4 861 4/25/2018
2.33.2 27,114 4/3/2018
2.33.1 1,253 4/3/2018
2.33.0 1,394 3/19/2018
2.32.2 1,458 3/12/2018
2.32.0 1,428 2/28/2018
2.31.0 1,485 2/5/2018
2.30.0 1,411 1/12/2018
2.29.1 1,540 12/29/2017
2.28.3 1,287 12/14/2017
2.28.2 1,275 12/7/2017
2.28.1 1,393 12/1/2017
2.28.0 1,357 11/30/2017
2.27.0 1,340 11/21/2017
2.26.3 1,445 10/26/2017
2.26.1 1,279 10/24/2017
2.26.0 1,204 10/23/2017
2.25.1 1,287 10/9/2017
2.25.0 1,486 10/9/2017
2.24.0 6,127 9/11/2017
2.23.1 1,256 8/22/2017
2.22.3 1,334 8/17/2017
2.22.1 1,448 8/2/2017
2.22.0 1,295 8/1/2017
2.21.2 1,270 7/26/2017
2.21.1 1,353 7/17/2017
2.20.0 1,318 7/12/2017
2.19.2 1,411 6/29/2017
2.18.5 1,367 6/15/2017
2.18.4 1,364 6/9/2017
2.18.3 1,382 6/8/2017
2.18.1 1,243 5/31/2017
2.17.5 1,208 5/23/2017
2.17.3 1,426 5/11/2017
2.17.2 1,223 5/9/2017
2.16.8 1,172 5/3/2017
2.16.7 1,234 4/26/2017
2.16.5 1,183 4/25/2017
2.16.2 1,175 4/20/2017
2.16.0 1,204 4/17/2017
2.15.5 1,832 4/6/2017
2.15.2 1,889 3/29/2017
2.13.1 1,786 3/7/2017
2.13.0 1,795 3/6/2017
2.12.1 1,930 2/14/2017
2.12.0 1,834 2/13/2017
2.11.3 1,688 2/7/2017
2.11.2 1,677 1/25/2017
2.11.1 1,741 1/24/2017
2.11.0 1,756 1/23/2017
2.10.2 1,757 1/4/2017
2.10.1 1,856 1/4/2017
2.10.0 1,984 1/3/2017
2.9.3 1,679 12/15/2016
2.9.2 1,715 12/14/2016
2.9.1 1,624 12/13/2016
2.9.0 1,647 12/12/2016
2.8.2 1,753 11/28/2016
2.8.1 1,784 11/24/2016
2.8.0 1,958 11/22/2016
2.7.3 2,059 11/8/2016
2.7.2 1,917 11/3/2016
2.7.1 1,987 11/1/2016
2.7.0 1,798 10/31/2016
2.6.3 1,759 10/25/2016
2.6.1 1,706 10/11/2016
2.6.0 1,751 10/10/2016
2.5.4 2,189 9/22/2016
2.5.3 2,047 9/20/2016
2.5.2 1,877 9/19/2016
2.5.1 1,891 9/19/2016
2.5.0 1,767 9/14/2016
2.4.0 1,524 8/29/2016
2.3.1 1,275 8/22/2016
2.3.0 1,449 8/8/2016
2.2.2 1,378 7/22/2016
2.2.1 1,355 7/19/2016
2.2.0 1,347 7/18/2016
2.1.0 1,472 6/27/2016
2.0.2 1,318 6/22/2016
2.0.1 1,393 6/7/2016
2.0.0 1,310 6/6/2016
1.9.4 1,542 5/19/2016
1.9.3 1,308 5/19/2016
1.9.0 1,320 5/16/2016
1.8.4 1,309 5/10/2016
1.8.1 1,365 5/4/2016
1.8.0 1,574 4/25/2016
1.7.2 1,316 4/20/2016
1.7.1 1,348 4/7/2016
1.7.0 1,392 4/6/2016
1.6.1 1,308 3/16/2016
1.5.0 1,494 2/22/2016
1.4.2 1,359 2/3/2016
1.4.1 1,263 2/2/2016
1.4.0 1,243 2/1/2016
1.3.7 1,322 1/21/2016
1.3.5 1,341 1/13/2016
1.3.3 1,437 1/13/2016
1.3.0 1,456 1/11/2016