README.md

API Reference Configuration

Applies to: Version 0.5 and later

Available Settings

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

Assembly Paths

Setting	mddocs:apireference:assemblyPaths
Commandline Parameter	assemblies
MSBuild Property	Determined automatically

The Assembly Paths setting specifies the paths of the assemblies to load in order to generate documentation.

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

Output Path

Setting	mddocs:apireference:outputPath
Commandline Parameter	outdir
MSBuild Property	ApiReferenceDocumentationOutputPath

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

Template Name

Setting	mddocs:apireference: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