DotBook 0.5.3-dev

This is a prerelease version of DotBook.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package DotBook --version 0.5.3-dev
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="DotBook" />
                    


                            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 DotBook --version 0.5.3-dev
                    


                    

                
#r "nuget: DotBook, 0.5.3-dev"
#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 DotBook@0.5.3-dev
#: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=DotBook&version=0.5.3-dev&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=DotBook&version=0.5.3-dev&prerelease
                    


                            Install as a Cake Tool

About the project

DotBook is a .NET CLI tool for human-friendly documentation generation from C# source files.

Currently supported formats are:

  • Markdown (can be uploaded to Github Pages directly)
  • HTML (suitable for offline browsing or iframe integration)

How to use

  1. Add the following item to your .csproj:
  <ItemGroup>
     <DotNetCliToolReference Include="DotBook" Version="0.5.3-dev"/>
  </ItemGroup>
  1. Run the dotnet restore command
  2. Use it! Run dotnet doc in the project folder to use default settings or dotnet doc --help for help.

Command-line options

Option format: -option, --option

  • o, output - Output directory for the generated documentation. If not specified, defaults to 'docs'.
  • s, src - Directory for C# code search
  • v, visibility - Include types and members with the specified visibilities. Defaults to 'public'.
  • h, use-hash - Use hashing for documentation filenames to allow deep hierarchies. If false, uses escaped type/member name. Defaults to 'false'.
  • f, format - Sets the output format. Default is Markdown. Available formats: Markdown, Html
  • ?, help - Displays the help message.

Examples

dotnet doc

dotnet doc --format html

dotnet doc --src /my-module --output /my-module-docs

There are no supported framework assets in this 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.5.10 777 4/21/2021
0.5.9 1,089 12/7/2018
0.5.8 1,088 10/2/2018
0.5.7 1,148 10/2/2018
0.5.6 1,526 7/16/2018
0.5.6-hotfix1 927 10/2/2018
0.5.6-hotfix 929 10/2/2018
0.5.5 1,998 1/7/2018
0.5.5-dev 1,379 1/5/2018
0.5.4-dev 1,456 1/4/2018
0.5.3-dev 1,495 1/3/2018
0.5.2-dev 1,496 1/3/2018
0.5.1-dev 1,429 1/3/2018
0.5.0-dev 1,492 1/2/2018