mirror of
https://github.com/fleschutz/PowerShell.git
synced 2024-12-27 00:58:51 +01:00
41 lines
1.0 KiB
Markdown
41 lines
1.0 KiB
Markdown
|
# PowerShell Script /home/mf/PowerShell/Scripts/convert-ps2md.ps1
|
||
|
|
|
||
|
|
## Synopsis
|
||
|
|
convert-ps2md.ps1 [<script>]
|
||
|
|
|
||
|
|
## Description
|
||
|
|
Converts the comment-based help of a PowerShell script to Markdown
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
```powershell
|
||
|
|
/home/mf/PowerShell/Scripts/convert-ps2md.ps1 [[-script] <String>] [<CommonParameters>]
|
||
|
|
```
|
||
|
|
|
||
|
|
## -script <String> Parameter
|
||
|
|
|
||
|
|
```
|
||
|
|
-script <String>
|
||
|
|
|
||
|
|
Required? false
|
||
|
|
Position? 1
|
||
|
|
Default value
|
||
|
|
Accept pipeline input? false
|
||
|
|
Accept wildcard characters? false
|
||
|
|
```
|
||
|
|
## <CommonParameters>
|
||
|
|
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
|
||
|
|
|
||
|
|
## Example
|
||
|
|
```powershell
|
||
|
|
PS>.\convert-ps2md.ps1 myscript.ps1
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
Author: Markus Fleschutz | License: CC0
|
||
|
|
|
||
|
|
## Related Links
|
||
|
|
https://github.com/fleschutz/PowerShell
|
||
|
|
|
||
|
|
*Created by convert-ps2md.ps1*
|