API Reference
New-ConfigurationDocumentation
Enables or disables creation of documentation from the module using PowerForge.
Remarks
This cmdlet emits documentation configuration segments that are consumed by Invoke-ModuleBuild / Build-Module. It controls markdown generation (in -Path), optional external help generation (MAML, e.g. en-US\<ModuleName>-help.xml), and whether generated documentation should be synced back to the project root. About topics are supported via about_*.help.txt / about_*.txt / about_*.md / about_*.markdown files present in the module source. When enabled, these are converted into markdown pages under Docs\About. Additional source roots can be provided via AboutTopicsSourcePath.
Examples
Generate markdown docs and external help, and sync back to project root
New-ConfigurationDocumentation -Enable -UpdateWhenNew -StartClean -Path 'Docs' -PathReadme 'Docs\Readme.md' -SyncExternalHelpToProjectRoot
Generate docs but skip about topics conversion and fallback examples
New-ConfigurationDocumentation -Enable -Path 'Docs' -PathReadme 'Docs\Readme.md' -SkipAboutTopics -SkipFallbackExamples
Generate docs and scan custom about topic folders in staging
New-ConfigurationDocumentation -Enable -Path 'Docs' -PathReadme 'Docs\Readme.md' -AboutTopicsSourcePath 'Help\About','Internals\About'
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-ConfigurationDocumentation [-AboutTopicsSourcePath <String[]>] [-Enable] [-ExternalHelpCulture <String>] [-ExternalHelpFileName <String>] -Path <String> -PathReadme <String> [-SkipAboutTopics] [-SkipExternalHelp] [-SkipFallbackExamples] [-StartClean] [-SyncExternalHelpToProjectRoot] [-Tool <PlatyPS|HelpOut|PowerForge>] [-UpdateWhenNew] [<CommonParameters>]All Parameter SetsParameters
- AboutTopicsSourcePath String[]
- Optional extra source paths for about_* topic files (.help.txt, .txt, .md, .markdown). Relative paths are resolved from the staging root (for example: 'Help\About').
- Enable SwitchParameter
- Enables creation of documentation from the module.
- ExternalHelpCulture String
- Culture folder for generated external help (default: en-US).
- ExternalHelpFileName String
- Optional file name override for external help (default: <ModuleName>-help.xml).
- Path String
- Path to the folder where documentation will be created.
- PathReadme String
- Path to the readme file that will be used for the documentation.
- SkipAboutTopics SwitchParameter
- Disable conversion of about_* topics into markdown pages.
- SkipExternalHelp SwitchParameter
- Disable external help (MAML) generation.
- SkipFallbackExamples SwitchParameter
- Disable generating basic fallback examples for cmdlets missing examples.
- StartClean SwitchParameter
- Removes all files from the documentation folder before creating new documentation.
- SyncExternalHelpToProjectRoot SwitchParameter
- When enabled and UpdateWhenNew is set, the generated external help file is also synced back to the project root (e.g. en-US\<ModuleName>-help.xml).
- Tool DocumentationTool
- Documentation engine (legacy parameter; kept for compatibility).
- Possible values:
PlatyPS,HelpOut,PowerForge - UpdateWhenNew SwitchParameter
- When enabled, generated documentation is also synced back to the project folder (not only to the staging build output).
Outputs
System.Object