jhoek / UncommonSense.PowerShell.Documentation

PowerShell module for converting PowerShell help information to MarkDown

Get-HelpAsMarkDown

PowerShell module for converting PowerShell help information to MarkDown

Design Considerations

Why not use a custom formatting file instead?

I agree that most of what Get-HelpAsMarkDown does could also be done using a formatting file, except for including a preface and postface.

Get-HelpAsMarkDown

Synopsis

Formats cmdlet help as MarkDown

Syntax

Get-HelpAsMarkDown [-Commands] <Object> [[-Title] <string>] [[-Description] <string>] [[-PrefacePath] <string>] [[-PostfacePath] <string>] [<CommonParameters>]

Output Type(s)

• System.String[]

Parameters

Commands <Object>

The command or commands to include in the MarkDown file

Required?                    true
Position?                    1
Default value                
Accept pipeline input?       true (ByValue)
Accept wildcard characters?  false

Title <String>

The title for the MarkDown file

Required?                    false
Position?                    2
Default value                
Accept pipeline input?       false
Accept wildcard characters?  false

Description <String>

A description describing this group of commands, e.g. a short module description

Required?                    false
Position?                    3
Default value                
Accept pipeline input?       false
Accept wildcard characters?  false

PrefacePath <String>

The path of the preface file. This file will be included in the output before the actual command help

Required?                    false
Position?                    4
Default value                
Accept pipeline input?       false
Accept wildcard characters?  false

PostfacePath <String>

The path of the postface file. This file will be included in the output after the actual command help

Required?                    false
Position?                    5
Default value                
Accept pipeline input?       false
Accept wildcard characters?  false

Examples

Example 1

Get-Command -Module IDYN.NAV.Automation | Sort-Object -Property Verb | Get-HelpAsMarkDown -Title IDYN.NAV.Automation -Description 'PowerShell cmdlets for IDYN developers.' | clip

Documents module IDYN.NAV.Automation, sorts the functions by verb name, adds a module title and description and copies the resulting text to the clipboard

Generated 02-12-2017 10:55