PowerShell/Docs/convert-ps2md.md

convert-ps2md.ps1 - Converts the comment-based help of a PowerShell script to Markdown

This PowerShell script converts the comment-based help of a PowerShell script to Markdown.

Parameters

convert-ps2md.ps1 [[-filename] <String>] [<CommonParameters>]

-filename <String>
    Specifies the path to the PowerShell script
    
    Required?                    false
    Position?                    1
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

[<CommonParameters>]
    This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, 
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.

Example

PS> ./convert-ps2md myscript.ps1

Notes

Author: Markus Fleschutz / License: CC0

Related Links

https://github.com/fleschutz/PowerShell

Generated by convert-ps2md.ps1 using the comment-based help of convert-ps2md.ps1