Evotec

Project

PSPublishModule

PSPublishModule is an open-source PowerShell and .NET project with packages, release history, and technical documentation.

View on GitHub Releases Get package
Stars 43
Forks 13
Open issues 1
PowerShell Gallery downloads 13,876
Release v3.0.3
Language: C# Updated: 2026-04-14

API Reference

Cmdlet

New-ModuleAboutTopic

Namespace PSPublishModule
Inputs
None
Outputs
System.Object

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

Remarks

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

Authored help example

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

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.

Syntax

New-ModuleAboutTopic [-Force] [-Format <HelpText|Markdown>] [-OutputPath <String>] [-PassThru] [-ShortDescription <String>] -TopicName <String> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

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

Outputs

System.Object