extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2024-11-23 00:13:36 +01:00
Code Issues Packages Projects Releases Wiki Activity
8687ea644e
PowerShell/Docs/export-to-manuals.md
Markus Fleschutz 27bd366394 Update the comment based help text
2021-10-12 21:51:51 +02:00

1.3 KiB
Raw Blame History

export-to-manuals.ps1 - Exports all scripts as manuals

This script exports the comment based help of all PowerShell scripts as manuals.

Parameters

export-to-manuals.ps1 [[-FilePattern] <String>] [[-TargetDir] <String>] [<CommonParameters>]

-FilePattern <String>
    
    Required?                    false
    Position?                    1
    Default value                "$PSScriptRoot/*.ps1"
    Accept pipeline input?       false
    Accept wildcard characters?  false

-TargetDir <String>
    
    Required?                    false
    Position?                    2
    Default value                "$PSScriptRoot/../Docs"
    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>./export-to-manuals.ps1
Found 264 scripts, exporting to /home/markus/PowerShell/Docs...
✔️ exported 264 scripts as manuals in 28 sec

Notes

Author: Markus Fleschutz · License: CC0

Related Links

https://github.com/fleschutz/PowerShell

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