PowerShell/Docs/convert-ps2md.md

36 lines
970 B
Markdown
Raw Normal View History

2022-11-17 19:46:02 +01:00
## convert-ps2md.ps1 - Converts PowerShell script metadata to Markdown
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script converts the comment-based help of a PowerShell script to Markdown.
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2021-12-09 16:19:09 +01:00
convert-ps2md.ps1 [[-filename] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-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
```powershell
PS> ./convert-ps2md myscript.ps1
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
*Generated by convert-ps2md.ps1 using the comment-based help of convert-ps2md.ps1*