Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 2.12 KB

net-cli-tool.md

File metadata and controls

61 lines (38 loc) · 2.12 KB

MdDocs .NET CLI tool

Applies to: Version 0.6 and later

Installation

MdDocs is a distributed as NuGet packages.

  • Prerelease builds are available on MyGet
  • Release versions are available on NuGet.org

MdDocs can be used either as .NET Core CLI tool or integrated into the project build as a set of MSBuild targets (see MdDocs MSBuild Integration).

NuGet

The package Grynwald.MdDocs provides MdDocs as a .NET CLI tool. To install it, run

dotnet tool install --global Grynwald.MdDocs

Prerequisites

The Grynwald.MdDocs package requires the .NET 6 (or later) SDK to be installed.

Usage

See also: Command Line Reference

API Reference

To generate API reference documentation for one or more .NET assemblies, run:

mddocs apireference --assemblies <PATH-TO-ASSEMBLY-1> <PATH-TO-ASSEMBLY-2> --outdir <OUTPUT-DIRECTORY>

⚠️ Note: If the output directory already exists, all files in the output directory will be deleted.

Command Line Help

To generate command line help for .NET console application implemented using the CommandLineParser package, run:

mddocs commandlinehelp --assembly <PATH-TO-ASSEMBLY> --outdir <OUTPUT-DIRECTORY>

⚠️ Note: If the output directory already exists, all files in the output directory will be deleted.

For an example of what the output looks like, have a look at the demo project.

See Also