DocfxChapterNumbersPlugin 0.9.1-g6ded756065

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of DocfxChapterNumbersPlugin. 
dotnet add package DocfxChapterNumbersPlugin --version 0.9.1-g6ded756065
                    


                    

                
NuGet\Install-Package DocfxChapterNumbersPlugin -Version 0.9.1-g6ded756065
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="DocfxChapterNumbersPlugin" Version="0.9.1-g6ded756065" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="DocfxChapterNumbersPlugin" Version="0.9.1-g6ded756065" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="DocfxChapterNumbersPlugin" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add DocfxChapterNumbersPlugin --version 0.9.1-g6ded756065
                    


                    

                
#r "nuget: DocfxChapterNumbersPlugin, 0.9.1-g6ded756065"
#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. 
#:package DocfxChapterNumbersPlugin@0.9.1-g6ded756065
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=DocfxChapterNumbersPlugin&version=0.9.1-g6ded756065&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=DocfxChapterNumbersPlugin&version=0.9.1-g6ded756065&prerelease
                    


                            Install as a Cake Tool

A Docfx plugin that adds chapter numbers to conceptual articles and the table of contents.

Usage

Setup

There are two basic ways to include this in your Docfx build. Both require you to first create a folder (or use an existing one), wherein you create sub folder named plugins.

Into this plugins folder you copy the DocfxChapterNumbersPlugin.dll.

For the sake of the following, assume the directory is called my-template\plugins and is exists next to your docfx.json file.

Note that chapter numbers will only be added for conceptal articles that are referenced by a "toc" file. Since you might have multiple (sub) toc files in your complete documentation, and might not want to add chapter numbers to all of them (say for reference / API docs), you need to specify for which sub folders you want to. You do this by specifying the chapterNumbersOn meta data.

Include via command line options

To include the post processor only via the command line, call Docfx as follows:

docfx build --postProcessors ChapterNumbers --template "default,modern,my-template" --metadata "chapterNumbersOn=articles"

Include via docfx.json

Include your template directory my-template in the templates array and include ChapterNumbers in the postProcessors array. Also specify for which sub directory inside of your sources the chapter numbers shall be created. Add this directory name to the chapterNumbersOn global metadata.

Create a folder (say my-template) and in there create a subfolder plugins. In this folder copy

{
    "build": {
        ...
        "postProcessors": [ "ChapterNumbers" ]
    },
    "template": [
        ...
        "my-template"
    ],
    "globalMetadata": {
        ...
        "chapterNumbersOn": [ "articles" ]
    }
}
Product Compatible and additional computed target framework versions.
.NET 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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.9.1-g6ded756065 154 6/6/2025
0.9.0-g175726aa4e 135 6/6/2025