API Reference
Command
Show-ModuleDocumentation
Displays module documentation (README, CHANGELOG, LICENSE, Intro/Upgrade) in the console.
Remarks
Displays module documentation (README, CHANGELOG, LICENSE, Intro/Upgrade) in the console. Resolves documentation files from an installed module (root or Internals folder) and renders them with Spectre.Console. When local files are absent or when requested, it can fetch files directly from the module's repository specified by PrivateData.PSData.ProjectUri (GitHub or Azure DevOps), optionally using a Personal Access Token.
Examples
EXAMPLE 1
Show-ModuleDocumentation -DocsPath 'C:\Path'
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
Show-ModuleDocumentation [-DisableTokenizer] [-DoNotShow] [-ExamplesLayout <MamlDefault|ProseFirst|AllAsCode>] [-ExamplesMode <Auto|Raw|Maml>] [-Fast] [-File <String>] [-HeadingRules <H1|H1AndH2>] [-HelpAsCode] [-HelpTimeoutSeconds <Int32>] [-MaxCommands <Int32>] [-Mode <PreferLocal|PreferRemote|All>] [-Name <String>] [-Online] [-Open] [-OutputPath <String>] [-PreferInternals] [-RepositoryBranch <String>] [-RepositoryPaths <String[]>] [-RepositoryToken <String>] [-RequiredVersion <Version>] [-ShowDuplicates] [-SkipCommands] [-SkipDependencies] [<CommonParameters>]Parameter set:
ByNameParameters
- DisableTokenizer SwitchParameter
- Disable code tokenizers and render code fences as plain text.
- DoNotShow SwitchParameter
- Do not open the generated HTML after export.
- ExamplesLayout String
- Controls how examples are rendered: ProseFirst (remarks then code), MamlDefault (code then remarks), or AllAsCode. Default is ProseFirst.
- Possible values:
MamlDefault,ProseFirst,AllAsCode - ExamplesMode String
- Controls how Examples are sourced. Raw = parse the EXAMPLES section from Get-Help text; Maml = use structured help object; Auto = Raw then Maml.
- Possible values:
Auto,Raw,Maml - Fast SwitchParameter
- Convenience switch equal to -SkipRemote -SkipDependencies -SkipCommands.
- File String
- Show a specific file by name (relative to module root or Internals) or full path.
- HeadingRules String
- Heading rulers style. H1AndH2 draws rules for H1/H2, H1 for H1 only, None disables.
- Possible values:
H1,H1AndH2 - HelpAsCode SwitchParameter
- Render command help inside fenced code blocks for uniform monospace formatting.
- HelpTimeoutSeconds Int32
- Per-command Get-Help timeout in seconds. Default 3.
- MaxCommands Int32
- Limit the number of commands rendered in the Commands tab. Default 100.
- Mode String
- Selection policy for standard tabs when Local and Remote exist (applies only when -Online): PreferLocal (default), PreferRemote, or All.
- Possible values:
PreferLocal,PreferRemote,All - Name String
- Module name to display documentation for.
- Online SwitchParameter
- Enable repository access (fetch remote docs using manifest defaults or -Repository* overrides).
- Open SwitchParameter
- Open the generated HTML in the default shell handler after export.
- OutputPath String
- Output location for the generated HTML. Accepts a file path or an existing directory. Defaults to temp when omitted.
- PreferInternals SwitchParameter
- Prefer Internals folder over module root when both contain the same file kind.
- RepositoryBranch String
- Branch name to use when fetching remote docs. If omitted, the provider default branch is used.
- RepositoryPaths String[]
- Repository-relative folders to enumerate and display (e.g., 'docs', 'articles'). Only .md/.markdown/.txt files are rendered.
- RepositoryToken String
- Personal Access Token for private repositories. Alternatively set environment variables: GitHub: PG_GITHUB_TOKEN or GITHUB_TOKEN; Azure DevOps: PG_AZDO_PAT or AZURE_DEVOPS_EXT_PAT.
- RequiredVersion Version
- Exact version to select when multiple module versions are installed.
- ShowDuplicates SwitchParameter
- Show both variants even when content is identical (root vs internals and local vs remote).
- SkipCommands SwitchParameter
- Skip building the Commands tab (fast export).
- SkipDependencies SwitchParameter
- Skip building the dependency list and graph.
Show-ModuleDocumentation [-DisableTokenizer] [-DoNotShow] [-ExamplesLayout <MamlDefault|ProseFirst|AllAsCode>] [-ExamplesMode <Auto|Raw|Maml>] [-Fast] [-File <String>] [-HeadingRules <H1|H1AndH2>] [-HelpAsCode] [-HelpTimeoutSeconds <Int32>] [-MaxCommands <Int32>] [-Mode <PreferLocal|PreferRemote|All>] [-Module <PSModuleInfo>] [-Online] [-Open] [-OutputPath <String>] [-PreferInternals] [-RepositoryBranch <String>] [-RepositoryPaths <String[]>] [-RepositoryToken <String>] [-RequiredVersion <Version>] [-ShowDuplicates] [-SkipCommands] [-SkipDependencies] [<CommonParameters>]Parameter set:
ByModuleParameters
- DisableTokenizer SwitchParameter
- Disable code tokenizers and render code fences as plain text.
- DoNotShow SwitchParameter
- Do not open the generated HTML after export.
- ExamplesLayout String
- Controls how examples are rendered: ProseFirst (remarks then code), MamlDefault (code then remarks), or AllAsCode. Default is ProseFirst.
- Possible values:
MamlDefault,ProseFirst,AllAsCode - ExamplesMode String
- Controls how Examples are sourced. Raw = parse the EXAMPLES section from Get-Help text; Maml = use structured help object; Auto = Raw then Maml.
- Possible values:
Auto,Raw,Maml - Fast SwitchParameter
- Convenience switch equal to -SkipRemote -SkipDependencies -SkipCommands.
- File String
- Show a specific file by name (relative to module root or Internals) or full path.
- HeadingRules String
- Heading rulers style. H1AndH2 draws rules for H1/H2, H1 for H1 only, None disables.
- Possible values:
H1,H1AndH2 - HelpAsCode SwitchParameter
- Render command help inside fenced code blocks for uniform monospace formatting.
- HelpTimeoutSeconds Int32
- Per-command Get-Help timeout in seconds. Default 3.
- MaxCommands Int32
- Limit the number of commands rendered in the Commands tab. Default 100.
- Mode String
- Selection policy for standard tabs when Local and Remote exist (applies only when -Online): PreferLocal (default), PreferRemote, or All.
- Possible values:
PreferLocal,PreferRemote,All - Module PSModuleInfo
- Module object to display documentation for. Alternative to -Name.
- Online SwitchParameter
- Enable repository access (fetch remote docs using manifest defaults or -Repository* overrides).
- Open SwitchParameter
- Open the generated HTML in the default shell handler after export.
- OutputPath String
- Output location for the generated HTML. Accepts a file path or an existing directory. Defaults to temp when omitted.
- PreferInternals SwitchParameter
- Prefer Internals folder over module root when both contain the same file kind.
- RepositoryBranch String
- Branch name to use when fetching remote docs. If omitted, the provider default branch is used.
- RepositoryPaths String[]
- Repository-relative folders to enumerate and display (e.g., 'docs', 'articles'). Only .md/.markdown/.txt files are rendered.
- RepositoryToken String
- Personal Access Token for private repositories. Alternatively set environment variables: GitHub: PG_GITHUB_TOKEN or GITHUB_TOKEN; Azure DevOps: PG_AZDO_PAT or AZURE_DEVOPS_EXT_PAT.
- RequiredVersion Version
- Exact version to select when multiple module versions are installed.
- ShowDuplicates SwitchParameter
- Show both variants even when content is identical (root vs internals and local vs remote).
- SkipCommands SwitchParameter
- Skip building the Commands tab (fast export).
- SkipDependencies SwitchParameter
- Skip building the dependency list and graph.
Show-ModuleDocumentation [-DisableTokenizer] [-DocsPath <String>] [-DoNotShow] [-ExamplesLayout <MamlDefault|ProseFirst|AllAsCode>] [-ExamplesMode <Auto|Raw|Maml>] [-Fast] [-File <String>] [-HeadingRules <H1|H1AndH2>] [-HelpAsCode] [-HelpTimeoutSeconds <Int32>] [-MaxCommands <Int32>] [-Mode <PreferLocal|PreferRemote|All>] [-Online] [-Open] [-OutputPath <String>] [-PreferInternals] [-RepositoryBranch <String>] [-RepositoryPaths <String[]>] [-RepositoryToken <String>] [-ShowDuplicates] [-SkipCommands] [-SkipDependencies] [<CommonParameters>]Parameter set:
ByPathParameters
- DisableTokenizer SwitchParameter
- Disable code tokenizers and render code fences as plain text.
- DocsPath String
- Direct path to a documentation folder containing README/CHANGELOG/etc.
- DoNotShow SwitchParameter
- Do not open the generated HTML after export.
- ExamplesLayout String
- Controls how examples are rendered: ProseFirst (remarks then code), MamlDefault (code then remarks), or AllAsCode. Default is ProseFirst.
- Possible values:
MamlDefault,ProseFirst,AllAsCode - ExamplesMode String
- Controls how Examples are sourced. Raw = parse the EXAMPLES section from Get-Help text; Maml = use structured help object; Auto = Raw then Maml.
- Possible values:
Auto,Raw,Maml - Fast SwitchParameter
- Convenience switch equal to -SkipRemote -SkipDependencies -SkipCommands.
- File String
- Show a specific file by name (relative to module root or Internals) or full path.
- HeadingRules String
- Heading rulers style. H1AndH2 draws rules for H1/H2, H1 for H1 only, None disables.
- Possible values:
H1,H1AndH2 - HelpAsCode SwitchParameter
- Render command help inside fenced code blocks for uniform monospace formatting.
- HelpTimeoutSeconds Int32
- Per-command Get-Help timeout in seconds. Default 3.
- MaxCommands Int32
- Limit the number of commands rendered in the Commands tab. Default 100.
- Mode String
- Selection policy for standard tabs when Local and Remote exist (applies only when -Online): PreferLocal (default), PreferRemote, or All.
- Possible values:
PreferLocal,PreferRemote,All - Online SwitchParameter
- Enable repository access (fetch remote docs using manifest defaults or -Repository* overrides).
- Open SwitchParameter
- Open the generated HTML in the default shell handler after export.
- OutputPath String
- Output location for the generated HTML. Accepts a file path or an existing directory. Defaults to temp when omitted.
- PreferInternals SwitchParameter
- Prefer Internals folder over module root when both contain the same file kind.
- RepositoryBranch String
- Branch name to use when fetching remote docs. If omitted, the provider default branch is used.
- RepositoryPaths String[]
- Repository-relative folders to enumerate and display (e.g., 'docs', 'articles'). Only .md/.markdown/.txt files are rendered.
- RepositoryToken String
- Personal Access Token for private repositories. Alternatively set environment variables: GitHub: PG_GITHUB_TOKEN or GITHUB_TOKEN; Azure DevOps: PG_AZDO_PAT or AZURE_DEVOPS_EXT_PAT.
- ShowDuplicates SwitchParameter
- Show both variants even when content is identical (root vs internals and local vs remote).
- SkipCommands SwitchParameter
- Skip building the Commands tab (fast export).
- SkipDependencies SwitchParameter
- Skip building the dependency list and graph.
Show-ModuleDocumentation [-DisableTokenizer] [-DoNotShow] [-ExamplesLayout <MamlDefault|ProseFirst|AllAsCode>] [-ExamplesMode <Auto|Raw|Maml>] [-Fast] [-File <String>] [-HeadingRules <H1|H1AndH2>] [-HelpAsCode] [-HelpTimeoutSeconds <Int32>] [-MaxCommands <Int32>] [-Mode <PreferLocal|PreferRemote|All>] [-ModuleBase <String>] [-Online] [-Open] [-OutputPath <String>] [-PreferInternals] [-RepositoryBranch <String>] [-RepositoryPaths <String[]>] [-RepositoryToken <String>] [-ShowDuplicates] [-SkipCommands] [-SkipDependencies] [<CommonParameters>]Parameter set:
ByBaseParameters
- DisableTokenizer SwitchParameter
- Disable code tokenizers and render code fences as plain text.
- DoNotShow SwitchParameter
- Do not open the generated HTML after export.
- ExamplesLayout String
- Controls how examples are rendered: ProseFirst (remarks then code), MamlDefault (code then remarks), or AllAsCode. Default is ProseFirst.
- Possible values:
MamlDefault,ProseFirst,AllAsCode - ExamplesMode String
- Controls how Examples are sourced. Raw = parse the EXAMPLES section from Get-Help text; Maml = use structured help object; Auto = Raw then Maml.
- Possible values:
Auto,Raw,Maml - Fast SwitchParameter
- Convenience switch equal to -SkipRemote -SkipDependencies -SkipCommands.
- File String
- Show a specific file by name (relative to module root or Internals) or full path.
- HeadingRules String
- Heading rulers style. H1AndH2 draws rules for H1/H2, H1 for H1 only, None disables.
- Possible values:
H1,H1AndH2 - HelpAsCode SwitchParameter
- Render command help inside fenced code blocks for uniform monospace formatting.
- HelpTimeoutSeconds Int32
- Per-command Get-Help timeout in seconds. Default 3.
- MaxCommands Int32
- Limit the number of commands rendered in the Commands tab. Default 100.
- Mode String
- Selection policy for standard tabs when Local and Remote exist (applies only when -Online): PreferLocal (default), PreferRemote, or All.
- Possible values:
PreferLocal,PreferRemote,All - ModuleBase String
- Path to a module root (folder that contains the module manifest). Useful for unpacked builds.
- Online SwitchParameter
- Enable repository access (fetch remote docs using manifest defaults or -Repository* overrides).
- Open SwitchParameter
- Open the generated HTML in the default shell handler after export.
- OutputPath String
- Output location for the generated HTML. Accepts a file path or an existing directory. Defaults to temp when omitted.
- PreferInternals SwitchParameter
- Prefer Internals folder over module root when both contain the same file kind.
- RepositoryBranch String
- Branch name to use when fetching remote docs. If omitted, the provider default branch is used.
- RepositoryPaths String[]
- Repository-relative folders to enumerate and display (e.g., 'docs', 'articles'). Only .md/.markdown/.txt files are rendered.
- RepositoryToken String
- Personal Access Token for private repositories. Alternatively set environment variables: GitHub: PG_GITHUB_TOKEN or GITHUB_TOKEN; Azure DevOps: PG_AZDO_PAT or AZURE_DEVOPS_EXT_PAT.
- ShowDuplicates SwitchParameter
- Show both variants even when content is identical (root vs internals and local vs remote).
- SkipCommands SwitchParameter
- Skip building the Commands tab (fast export).
- SkipDependencies SwitchParameter
- Skip building the dependency list and graph.