Command

New-ModuleAboutTopic

Module: PSPublishModule
Inputs: None

Creates an about_*.help.txt template source file for module documentation.

Syntax

New-ModuleAboutTopic
[-Force]
[-Format <HelpText|Markdown>]
[-OutputPath <String>]
[-PassThru]
[-ShortDescription <String>]
[-TopicName] <String>
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

Use this cmdlet to scaffold about topic source files that are later converted by Invoke-ModuleBuild documentation generation into markdown pages under Docs\About.

Examples

Create a new topic in a dedicated source folder

New-ModuleAboutTopic -TopicName 'Troubleshooting' -OutputPath '.\Help\About'

Overwrite an existing topic template

New-ModuleAboutTopic -TopicName 'about_Configuration' -OutputPath '.\Help\About' -Force

Create markdown about topic source

New-ModuleAboutTopic -TopicName 'Troubleshooting' -OutputPath '.\Help\About' -Format Markdown

Parameters

-Force SwitchParameter optional: Overwrite existing file if it already exists.
-Format AboutTopicTemplateFormat optional: Output format for the scaffolded about topic file.; Possible values: HelpText, Markdown
-OutputPath String optionalaliases: Path: Output directory for the source file.
-PassThru SwitchParameter optional: Returns the created file path.
-ShortDescription String optional: Optional short description seed for the generated template.
-TopicName String requiredposition: 0: Topic name. The about_ prefix is added automatically when missing.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.