mirror of
https://github.com/fleschutz/PowerShell.git
synced 2024-11-09 01:25:04 +01:00
Add more manuals
This commit is contained in:
parent
61b9cb62d5
commit
acc88e247d
43
Docs/export-to-manuals.md
Normal file
43
Docs/export-to-manuals.md
Normal file
@ -0,0 +1,43 @@
|
||||
## export-to-manuals.ps1 - Exports all scripts as manuals
|
||||
|
||||
This script exports the comment based help of all PowerShell scripts as manuals.
|
||||
|
||||
## Parameters
|
||||
```powershell
|
||||
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
|
||||
```powershell
|
||||
PS>./export-to-manuals.ps1
|
||||
Found 264 scripts, starting export 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*
|
43
Docs/export-to-serenade.md
Normal file
43
Docs/export-to-serenade.md
Normal file
@ -0,0 +1,43 @@
|
||||
## export-to-serenade.ps1 - Exports all scripts to Serenade for voice control
|
||||
|
||||
This script exports all PowerShell scripts to Serenade.ai for voice control.
|
||||
|
||||
## Parameters
|
||||
```powershell
|
||||
export-to-serenade.ps1 [[-FilePattern] <String>] [[-TargetFile] <String>] [<CommonParameters>]
|
||||
|
||||
-FilePattern <String>
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
Default value "$PSScriptRoot/*.ps1"
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
|
||||
-TargetFile <String>
|
||||
|
||||
Required? false
|
||||
Position? 2
|
||||
Default value "$HOME/.serenade/scripts/PowerShell.js"
|
||||
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>./export-to-serenade.ps1
|
||||
Found 264 scripts, starting export to C:\Users\Markus/.serenade/scripts/PowerShell.js...
|
||||
✔️ exported 264 PowerShell scripts for Serenade voice control in 22 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-serenade.ps1*
|
34
Docs/list-folder.md
Normal file
34
Docs/list-folder.md
Normal file
@ -0,0 +1,34 @@
|
||||
## list-folder.ps1 - Lists the folder content
|
||||
|
||||
This script lists the directory content formatted in columns.
|
||||
|
||||
## Parameters
|
||||
```powershell
|
||||
list-folder.ps1 [[-SearchPattern] <String>] [<CommonParameters>]
|
||||
|
||||
-SearchPattern <String>
|
||||
Specifies the search pattern, "*" by default (means anything)
|
||||
|
||||
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>./list-folder C:\
|
||||
```
|
||||
|
||||
## Notes
|
||||
Author: Markus Fleschutz · License: CC0
|
||||
|
||||
## Related Links
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
*Generated by convert-ps2md.ps1 using the comment-based help of list-folder.ps1*
|
Loading…
Reference in New Issue
Block a user