DotBook 0.5.4-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.4-dev

NuGet\Install-Package DotBook -Version 0.5.4-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.4-dev" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add DotBook --version 0.5.4-dev

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: DotBook, 0.5.4-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.

// Install DotBook as a Cake Addin
#addin nuget:?package=DotBook&version=0.5.4-dev&prerelease

// Install DotBook as a Cake Tool
#tool nuget:?package=DotBook&version=0.5.4-dev&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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

Add the following item to your .csproj:

  <ItemGroup>
     <DotNetCliToolReference Include="DotBook" Version="0.5.4-dev"/>
  </ItemGroup>

Run the dotnet restore command
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.

.NETCoreApp 2.0
- Colorful.Console (>= 1.2.1)
- Microsoft.CodeAnalysis (>= 2.4.0)
- Microsoft.NETCore.App (>= 2.0.0)
- Newtonsoft.Json (>= 10.0.3)

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	491	4/21/2021
0.5.9	848	12/7/2018
0.5.8	819	10/2/2018
0.5.7	869	10/2/2018
0.5.6	997	7/16/2018
0.5.6-hotfix1	671	10/2/2018
0.5.6-hotfix	671	10/2/2018
0.5.5	1,281	1/7/2018
0.5.5-dev	948	1/5/2018
0.5.4-dev	917	1/4/2018
0.5.3-dev	945	1/3/2018
0.5.2-dev	944	1/3/2018
0.5.1-dev	879	1/3/2018
0.5.0-dev	934	1/2/2018