Skip to content

Latest commit

 

History

History
136 lines (115 loc) · 3.78 KB

default.md

File metadata and controls

136 lines (115 loc) · 3.78 KB
Raw

Default Template

The default template creates a single Markdown document for the console application and documents for every command if the application has multiple commands.

Enabling the template

To use the default template, set the Template Name setting to Default. To customize the output produced by the default template, adjust the settings documented below.

Settings

Markdown Preset

Setting mddocs:commandlinehelp:template:default:markdownPreset
Commandline Parameter -
MSBuild Property -
Default value Default
Allowed values
  • Default
  • MkDocs

The Markdown Preset customizes serialization of Markdown.

Supported values are:

  • default: Produces Markdown that should work in most environments, including GitHub and GitLab
  • MkDocs: Produces Markdown optimized for being rendered by Python-Markdown and MkDocs

For details on the differences between the presets, see also Markdown Generator docs.

Include Version

Setting mddocs:commandlinehelp:template:default:includeVersion
Commandline Parameter -
MSBuild Property -
Default value true
Allowed values
  • true
  • false

The Include Version setting controls whether the version of the application is included in the generated documentation.

The version included in the documentation is the informational version if the application assembly has a AssemblyInformationalVersion attribute, otherwise the assembly version is used.

Include AutoGenerated Notice

Setting mddocs:commandlinehelp:template:default:includeAutoGeneratedNotice
Commandline Parameter -
MSBuild Property -
Default value true
Allowed values
  • true
  • false

By default, Markdown documents generated by MdDocs include a comment at the start of the document that indicates that the file was auto-generated. This notice is intended to avoid edits in files that will be lost when the file is regenerated.

The Include AutoGenerated Notice setting can be used to disable inclusion of this comment (by default, the comment is included):

{
    "mddocs" : {
        "commandlinehelp" : {
            "template" : {
                "default" : {
                    "includeAutoGeneratedNotice" : false
                }
            }
        }
    }
}

See Also