-
-
Notifications
You must be signed in to change notification settings - Fork 4
Save MarkdownHelp
James Brundage edited this page Apr 21, 2022
·
6 revisions
Saves a Module's Markdown Help
Get markdown help for each command in a module and saves it to the appropriate location.
Save-MarkdownHelp -Module HelpOut
The name of one or more modules.
Type | Requried | Postion | PipelineInput |
---|---|---|---|
[String[]] |
false | named | true (ByPropertyName) |
The output path.
If not provided, will be assumed to be the "docs" folder of a given module (unless -Wiki is specified)
Type | Requried | Postion | PipelineInput |
---|---|---|---|
[String] |
false | named | true (ByPropertyName) |
If set, will interlink documentation as if it were a wiki. Implied when -OutputPath contains 'wiki'. If provided without -OutputPath, will assume that a wiki resides in a sibling directory of the module.
Type | Requried | Postion | PipelineInput |
---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
Save-MarkdownHelp [-Module <String[]>] [-OutputPath <String>] [-Wiki] [<CommonParameters>]
Adding a footer
Testing if custom sidebar overrides automatic