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. 
Compatible target framework(s)
Additional computed target framework(s)
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 3,020 3/21/2023
2.63.0 517 3/20/2023
2.62.2 658 3/7/2023
2.62.1 1,966 2/15/2023
2.62.0 509 2/14/2023
2.61.0 2,593 1/30/2023
2.60.2 1,097 1/20/2023
2.60.1 679 1/18/2023
2.60.0 996 1/13/2023
2.60.0-preview.2 111 12/25/2022
2.60.0-preview.1 103 12/20/2022
2.59.4 8,586 9/7/2022
2.59.3 1,609 7/6/2022
2.59.2 4,763 4/11/2022
2.59.1 1,008 3/31/2022
2.59.0 2,673 1/19/2022
2.58.9 819 11/4/2021
2.58.8 478 11/1/2021
2.58.5 486 10/26/2021
2.58.4 3,562 9/14/2021
2.58.3 485 9/7/2021
2.58.2 497 8/24/2021
2.58.1 477 8/23/2021
2.58.0 1,316 6/9/2021
2.57.2 697 4/14/2021
2.57.1 543 4/13/2021
2.57.0 558 4/9/2021
2.56.7 1,598 3/2/2021
2.56.6 1,450 12/10/2020
2.56.5 829 11/10/2020
2.56.4 2,326 10/20/2020
2.56.3 646 10/12/2020
2.56.2 1,054 7/27/2020
2.56.1 799 7/6/2020
2.56.0 727 6/29/2020
2.55.0 826 6/12/2020
2.53.1 957 5/11/2020
2.52.0 1,344 4/13/2020
2.51.0 2,965 3/20/2020
2.50.0 978 3/2/2020
2.49.0 769 2/17/2020
2.48.1 2,620 1/13/2020
2.48.0 1,727 12/9/2019
2.47.0 22,238 10/31/2019
2.46.0 1,286 10/14/2019
2.45.1 2,961 9/15/2019
2.45.0 1,079 8/25/2019
2.44.0 1,794 8/2/2019
2.43.2 1,971 7/2/2019
2.43.1 1,101 6/14/2019
2.42.4 1,886 5/24/2019
2.42.3 13,282 5/21/2019
2.42.2 875 5/10/2019
2.42.0 921 4/22/2019
2.41.0 3,026 3/29/2019
2.40.12 966 3/11/2019
2.40.11 2,283 2/16/2019
2.40.10 1,166 2/1/2019
2.40.9 1,125 1/31/2019
2.40.8 1,132 1/25/2019
2.40.7 1,072 1/4/2019
2.40.5 1,124 12/19/2018
2.40.4 1,120 11/26/2018
2.40.2 1,522 11/7/2018
2.40.1 1,032 10/29/2018
2.40.0 1,087 10/12/2018
2.39.2 2,567 9/9/2018
2.39.1 2,509 9/4/2018
2.39.0 5,687 9/2/2018
2.38.1 5,845 8/16/2018
2.38.0 1,288 8/13/2018
2.37.2 1,207 7/31/2018
2.37.1 1,417 7/31/2018
2.36.2 1,476 6/13/2018
2.36.1 1,289 5/25/2018
2.36.0 1,337 5/21/2018
2.36.0-alpha-0159-g25e5900b4 922 4/26/2018
2.35.4 1,409 5/2/2018
2.35.3 1,348 5/2/2018
2.35.0-alpha-0153-g6da267dd4 807 4/25/2018
2.33.2 27,040 4/3/2018
2.33.1 1,191 4/3/2018
2.33.0 1,325 3/19/2018
2.32.2 1,390 3/12/2018
2.32.0 1,357 2/28/2018
2.31.0 1,403 2/5/2018
2.30.0 1,341 1/12/2018
2.29.1 1,471 12/29/2017
2.28.3 1,222 12/14/2017
2.28.2 1,207 12/7/2017
2.28.1 1,324 12/1/2017
2.28.0 1,289 11/30/2017
2.27.0 1,270 11/21/2017
2.26.3 1,380 10/26/2017
2.26.1 1,213 10/24/2017
2.26.0 1,164 10/23/2017
2.25.1 1,235 10/9/2017
2.25.0 1,415 10/9/2017
2.24.0 6,059 9/11/2017
2.23.1 1,206 8/22/2017
2.22.3 1,276 8/17/2017
2.22.1 1,392 8/2/2017
2.22.0 1,240 8/1/2017
2.21.2 1,233 7/26/2017
2.21.1 1,285 7/17/2017
2.20.0 1,257 7/12/2017
2.19.2 1,357 6/29/2017
2.18.5 1,317 6/15/2017
2.18.4 1,294 6/9/2017
2.18.3 1,316 6/8/2017
2.18.1 1,163 5/31/2017
2.17.5 1,141 5/23/2017
2.17.3 1,355 5/11/2017
2.17.2 1,153 5/9/2017
2.16.8 1,117 5/3/2017
2.16.7 1,163 4/26/2017
2.16.5 1,114 4/25/2017
2.16.2 1,103 4/20/2017
2.16.0 1,130 4/17/2017
2.15.5 1,781 4/6/2017
2.15.2 1,817 3/29/2017
2.13.1 1,730 3/7/2017
2.13.0 1,739 3/6/2017
2.12.1 1,874 2/14/2017
2.12.0 1,776 2/13/2017
2.11.3 1,633 2/7/2017
2.11.2 1,605 1/25/2017
2.11.1 1,687 1/24/2017
2.11.0 1,681 1/23/2017
2.10.2 1,701 1/4/2017
2.10.1 1,798 1/4/2017
2.10.0 1,905 1/3/2017
2.9.3 1,615 12/15/2016
2.9.2 1,645 12/14/2016
2.9.1 1,549 12/13/2016
2.9.0 1,572 12/12/2016
2.8.2 1,696 11/28/2016
2.8.1 1,723 11/24/2016
2.8.0 1,897 11/22/2016
2.7.3 1,982 11/8/2016
2.7.2 1,858 11/3/2016
2.7.1 1,929 11/1/2016
2.7.0 1,707 10/31/2016
2.6.3 1,698 10/25/2016
2.6.1 1,636 10/11/2016
2.6.0 1,677 10/10/2016
2.5.4 2,111 9/22/2016
2.5.3 1,967 9/20/2016
2.5.2 1,804 9/19/2016
2.5.1 1,818 9/19/2016
2.5.0 1,686 9/14/2016
2.4.0 1,454 8/29/2016
2.3.1 1,205 8/22/2016
2.3.0 1,377 8/8/2016
2.2.2 1,310 7/22/2016
2.2.1 1,286 7/19/2016
2.2.0 1,277 7/18/2016
2.1.0 1,403 6/27/2016
2.0.2 1,250 6/22/2016
2.0.1 1,322 6/7/2016
2.0.0 1,240 6/6/2016
1.9.4 1,478 5/19/2016
1.9.3 1,236 5/19/2016
1.9.0 1,249 5/16/2016
1.8.4 1,256 5/10/2016
1.8.1 1,297 5/4/2016
1.8.0 1,518 4/25/2016
1.7.2 1,247 4/20/2016
1.7.1 1,277 4/7/2016
1.7.0 1,309 4/6/2016
1.6.1 1,239 3/16/2016
1.5.0 1,422 2/22/2016
1.4.2 1,288 2/3/2016
1.4.1 1,209 2/2/2016
1.4.0 1,190 2/1/2016
1.3.7 1,253 1/21/2016
1.3.5 1,285 1/13/2016
1.3.3 1,368 1/13/2016
1.3.0 1,383 1/11/2016