Microsoft.DocAsCode.Build.TableOfContents 2.67.5

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
Suggested Alternatives

Docfx.Build.TableOfContents

Additional Details

Docfx has been fully transitioned to be a .NET Foundation project entirely driven by the community for the interest of the community. Hence we are renaming the NuGet package names, assembly names and namespace names from Microsoft.DocAsCode.* to Docfx.*.

dotnet add package Microsoft.DocAsCode.Build.TableOfContents --version 2.67.5
NuGet\Install-Package Microsoft.DocAsCode.Build.TableOfContents -Version 2.67.5
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.Build.TableOfContents" Version="2.67.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Microsoft.DocAsCode.Build.TableOfContents --version 2.67.5
#r "nuget: Microsoft.DocAsCode.Build.TableOfContents, 2.67.5"
#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.Build.TableOfContents as a Cake Addin
#addin nuget:?package=Microsoft.DocAsCode.Build.TableOfContents&version=2.67.5

// Install Microsoft.DocAsCode.Build.TableOfContents as a Cake Tool
#tool nuget:?package=Microsoft.DocAsCode.Build.TableOfContents&version=2.67.5

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 ⚠️⚠️⚠️

DocFX is being transitioned to the .NET Foundation as an official .NET project!

  • The DocFX team is working on improving the main branch. This will introduce new features and bug fixes to the project, remove some older code and features that are no longer necessary, as well as update the dependencies and simplify the project structure. Stay tuned for a roadmap.
  • Due to architectural changes in the site, DocFX can no longer support building Microsoft Learn content directly. The open source repos holding Markdown content for Microsoft Learn will still accept pull requests and changes, but are not directly buildable with DocFX.
  • Moving forward, we will only be supporting this tool as a static site generator for new sites, not as a tool to build official Microsoft content on Microsoft Learn.

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 build 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.

License

This project is licensed under the MIT License.

.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.

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 (1)

Showing the top 1 NuGet packages that depend on Microsoft.DocAsCode.Build.TableOfContents:

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

Docfx published as a library for extensibility and advanced customization

GitHub repositories (1)

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

Repository Stars
hazelcast/hazelcast-csharp-client
Hazelcast .NET Client
Version Downloads Last updated
2.67.5 8,366 6/21/2023
2.67.3 1,989 6/2/2023
2.67.2 840 5/26/2023
2.67.1 943 5/16/2023
2.67.0 1,310 5/6/2023
2.66.2 4,682 4/26/2023
2.66.1 811 4/25/2023
2.66.0 816 4/24/2023
2.65.3 911 4/14/2023
2.65.2 838 4/11/2023
2.65.1 787 4/9/2023
2.65.0 804 4/7/2023
2.64.0 5,206 3/30/2023
2.63.1 1,069 3/21/2023
2.63.0 792 3/20/2023
2.62.2 935 3/7/2023
2.62.1 2,349 2/15/2023
2.62.0 847 2/14/2023
2.61.0 2,792 1/30/2023
2.60.2 1,312 1/20/2023
2.60.1 872 1/18/2023
2.60.0 1,296 1/13/2023
2.60.0-preview.2 126 12/25/2022
2.60.0-preview.1 123 12/20/2022
2.59.4 10,927 9/7/2022
2.59.3 1,745 7/6/2022
2.59.2 4,906 4/11/2022
2.59.1 1,183 3/31/2022
2.59.0 3,208 1/19/2022
2.58.9 1,229 11/4/2021
2.58.8 1,009 11/1/2021
2.58.5 982 10/26/2021
2.58.4 4,187 9/14/2021
2.58.3 1,042 9/7/2021
2.58.2 992 8/24/2021
2.58.1 981 8/23/2021
2.58.0 1,319 6/9/2021
2.57.2 1,114 4/14/2021
2.57.1 1,003 4/13/2021
2.57.0 1,008 4/9/2021
2.56.7 2,210 3/2/2021
2.56.6 1,844 12/10/2020
2.56.5 1,179 11/10/2020
2.56.4 1,453 10/20/2020
2.56.3 1,130 10/12/2020
2.56.2 1,322 7/27/2020
2.56.1 1,119 7/6/2020
2.56.0 1,217 6/29/2020
2.55.0 1,204 6/12/2020
2.53.1 1,259 5/11/2020
2.52.0 1,492 4/13/2020
2.51.0 3,563 3/20/2020
2.50.0 1,463 3/2/2020
2.49.0 1,275 2/17/2020
2.48.1 2,591 1/13/2020
2.48.0 1,565 12/9/2019
2.47.0 1,533 10/31/2019
2.46.0 1,500 10/14/2019
2.45.1 3,266 9/15/2019
2.45.0 1,487 8/25/2019
2.44.0 1,542 8/2/2019
2.43.2 2,351 7/2/2019
2.43.1 1,361 6/14/2019
2.42.4 2,121 5/24/2019
2.42.3 13,629 5/13/2019
2.42.2 1,265 5/10/2019
2.42.0 1,389 4/22/2019
2.41.0 1,709 3/29/2019
2.40.12 1,312 3/11/2019
2.40.11 1,789 2/16/2019
2.40.10 1,411 2/1/2019
2.40.9 1,423 1/31/2019
2.40.8 1,386 1/25/2019
2.40.7 1,444 1/4/2019
2.40.5 1,431 12/19/2018
2.40.4 1,479 11/26/2018
2.40.2 1,780 11/7/2018
2.40.1 1,459 10/29/2018
2.40.0 1,518 10/12/2018
2.39.2 2,976 9/9/2018
2.39.1 2,905 9/4/2018
2.39.0 6,805 9/2/2018
2.38.1 6,134 8/16/2018
2.38.0 1,707 8/13/2018
2.37.2 1,575 7/31/2018
2.37.1 1,547 7/31/2018
2.36.2 1,641 6/13/2018
2.36.1 1,716 5/25/2018
2.36.0 1,721 5/21/2018
2.36.0-alpha-0159-g25e5900b4 1,330 4/26/2018
2.35.4 1,783 5/2/2018
2.35.3 1,756 5/2/2018
2.35.0-alpha-0153-g6da267dd4 1,404 4/25/2018
2.33.2 2,006 4/3/2018
2.33.1 1,622 4/3/2018
2.33.0 1,764 3/19/2018
2.32.2 1,794 3/12/2018
2.32.0 1,751 2/28/2018
2.31.0 1,645 2/5/2018
2.30.0 1,776 1/12/2018
2.29.1 1,715 12/29/2017
2.28.3 1,607 12/14/2017
2.28.2 1,603 12/7/2017
2.28.1 1,607 12/1/2017
2.28.0 1,637 11/30/2017
2.27.0 1,624 11/21/2017
2.26.3 1,710 10/26/2017
2.26.1 1,640 10/24/2017
2.26.0 1,635 10/23/2017
2.25.1 1,616 10/9/2017
2.25.0 1,624 10/9/2017
2.24.0 1,737 9/11/2017
2.23.1 1,650 8/22/2017
2.22.3 1,649 8/17/2017
2.22.1 1,723 8/2/2017
2.22.0 1,701 8/1/2017
2.21.2 1,701 7/26/2017
2.21.1 1,685 7/17/2017
2.20.0 1,692 7/12/2017
2.19.2 1,677 6/29/2017
2.18.5 1,701 6/15/2017
2.18.4 1,709 6/9/2017
2.18.3 1,743 6/8/2017
2.18.1 1,662 5/31/2017
2.17.5 1,708 5/23/2017
2.17.3 1,655 5/11/2017
2.17.2 1,686 5/9/2017
2.16.8 1,663 5/3/2017
2.16.7 1,665 4/26/2017
2.16.5 1,677 4/25/2017
2.16.2 1,610 4/20/2017
2.16.0 1,689 4/17/2017
2.15.5 2,066 4/6/2017
2.15.2 2,026 3/29/2017
2.13.1 1,962 3/7/2017
2.13.0 1,992 3/6/2017
2.12.1 1,983 2/14/2017
2.12.0 1,957 2/13/2017
2.11.3 1,961 2/7/2017
2.11.2 1,951 1/25/2017
2.11.1 1,943 1/24/2017
2.11.0 1,928 1/23/2017
2.10.2 1,942 1/4/2017
2.10.1 1,919 1/4/2017
2.10.0 2,015 1/3/2017
2.9.3 1,960 12/15/2016
2.9.2 1,964 12/14/2016
2.9.1 2,061 12/13/2016
2.9.0 1,989 12/12/2016
2.8.2 2,036 11/28/2016
2.8.1 1,998 11/24/2016
2.8.0 2,034 11/22/2016
2.7.3 2,326 11/8/2016
2.7.2 2,253 11/3/2016
2.7.1 2,256 11/1/2016
2.7.0 2,122 10/31/2016
2.6.3 2,010 10/25/2016
2.6.1 1,913 10/11/2016
2.6.0 2,003 10/10/2016
2.5.4 2,446 9/22/2016
2.5.3 2,422 9/20/2016
2.5.2 2,121 9/19/2016
2.5.1 2,278 9/19/2016
2.5.0 2,004 9/14/2016
2.4.0 1,957 8/29/2016
2.3.1 1,865 8/22/2016
2.3.0 1,982 8/8/2016
2.2.2 1,919 7/22/2016
2.2.1 1,882 7/19/2016
2.2.0 1,885 7/18/2016
2.1.0 2,006 6/27/2016
2.0.2 1,881 6/22/2016
2.0.1 1,916 6/7/2016
2.0.0 1,897 6/6/2016
1.9.4 2,212 5/19/2016
1.9.3 1,898 5/19/2016
1.9.0 1,941 5/16/2016
1.8.4 1,932 5/10/2016
1.8.1 2,007 5/4/2016
1.8.0 2,209 4/25/2016
1.7.2 1,940 4/20/2016
1.7.1 1,903 4/7/2016
1.7.0 2,069 4/6/2016