README.md

Command Line Help Configuration

Applies to: Version 0.4 and later

Available Settings

• Assembly Path
• Output Path
• Template Name
• Templates
  • Default
    • Markdown Preset
    • Include Version
    • Include AutoGenerated Notice

Assembly Path

Setting	mddocs:commandlinehelp:assemblyPath
Commandline Parameter	assembly
MSBuild Property	Determined automatically

The Assembly Path setting specifies the path of the assembly to load in order to generate documentation.

ℹ Note: When using MdDocs MSBuild Integration, setting the assembly path has no effect because the MSBuild targets use the target path of the current project.

Output Path

Setting	mddocs:commandlinehelp:outputPath
Commandline Parameter	outdir
MSBuild Property	CommandLineDocumentationOutputPath

The Output Path setting defines the path of the directory the generated documentation is written to.

Template Name

Setting	mddocs:commandlinehelp:template:name
Commandline Parameter	-
MSBuild Property	-
Allowed values	Default

The Template Name setting defines the template to use for generating Markdown. Currently, the only supported template is the default template (template name Default).

See Also

• Configuration Overview
• Default Template Setttings
• MdDocs .NET CLI Tool
• MdDocs MSBuild Integration