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
Stars43
Forks13
Open issues2
PowerShell Gallery downloads13876
Releasev3.0.3
Language: C# Updated: 2026-04-12T07:25:36.0000000+00:00

Curated Examples

Configure module documentation generation

Configure generated PowerShell command help and about-topic output.

This pattern is useful when a binary PowerShell module should generate Markdown help and external help XML during its build.

It is adapted from Docs/PSPublishModule.ModuleDocumentation.md.

Example

Invoke-ModuleBuild -ModuleName 'MyModule' -Path 'C:\Git\MyModule' -Settings {
    New-ConfigurationDocumentation `
        -Enable `
        -StartClean `
        -UpdateWhenNew `
        -Path 'Docs' `
        -PathReadme 'Docs\Readme.md' `
        -AboutTopicsSourcePath 'Help\About' `
        -SyncExternalHelpToProjectRoot
}

What this demonstrates

  • treating generated docs as build output
  • using Help/About for durable about-topic sources
  • keeping command help generated from authored PowerShell/XML documentation

Source