Skip to content

Commit 4c31328

Browse files
Nick2bad4uNick2bad4u
committed
📝 [docs] Regenerate and enhance PlatyPS help documentation
This commit overhauls the module's help documentation by regenerating all markdown files using a newer version of PlatyPS. It also introduces a new build script for managing and publishing help content. 📝 [docs] **Help File Regeneration** - Updates all cmdlet markdown help files (`.md`) to a new, more detailed PlatyPS schema (`2024-05-01`). - Enriches parameter documentation with full YAML definitions, including type, default values, parameter sets, and positions. - Adds `HelpUri` to the frontmatter of each help file, pointing to the project's GitHub repository for better discoverability. - Updates the module manifest (`.psd1`) to point `HelpInfoURI` to a new GitHub Pages site, enabling updatable help via `Update-Help`. 🔧 [build] **New Help Build Process** - Introduces a new `Build-Help.ps1` script to automate the generation of MAML XML files from the updated markdown. - The script now runs PlatyPS cmdlets in an isolated PowerShell process to ensure compatibility and avoid module conflicts. - Adds logic to publish help content to the `docs` directory for GitHub Pages deployment. 🎨 [style] **Minor Code Formatting** - Adjusts brace style in a `foreach` loop within `Show-ColorScript` for consistency. This is a non-functional, cosmetic change. Signed-off-by: Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com>
1 parent 0d48754 commit 4c31328

15 files changed

Lines changed: 1392 additions & 620 deletions

‎ColorScripts-Enhanced/ColorScripts-Enhanced.psd1‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
#
44
# Generated by: Nick2bad4u
55
#
6-
# Generated on: 10/25/2025
6+
# Generated on: 10/26/2025
77
#
88

99
@{
1010
# Script module or binary module file associated with this manifest.
1111
RootModule = 'ColorScripts-Enhanced.psm1'
1212

1313
# Version number of this module.
14-
ModuleVersion = '2025.10.25.0124'
14+
ModuleVersion = '2025.10.26.0233'
1515

1616
# Supported PSEditions
1717
CompatiblePSEditions = @('Desktop', 'Core')
@@ -172,7 +172,7 @@ Full documentation: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
172172

173173
# ReleaseNotes of this module
174174
ReleaseNotes = @'
175-
Version 2025.10.25.0124:
175+
Version 2025.10.26.0233:
176176
- Enhanced caching system with OS-wide cache in AppData
177177
- 6-19x performance improvement
178178
- Cache stored in centralized location
@@ -196,7 +196,7 @@ Version 2025.10.25.0124:
196196
}
197197

198198
# HelpInfo URI of this module
199-
HelpInfoURI = 'https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/README.md'
199+
HelpInfoURI = 'https://nick2bad4u.github.io/PS-Color-Scripts-Enhanced/ColorScripts-Enhanced/'
200200

201201
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
202202
# DefaultCommandPrefix = ''

‎ColorScripts-Enhanced/ColorScripts-Enhanced.psm1‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1943,10 +1943,9 @@ function Show-ColorScript {
19431943
Write-Host "Displaying continuously (Ctrl+C to stop)`n" -ForegroundColor Yellow
19441944
}
19451945

1946-
foreach ($script in $sortedScripts) {
1947-
$currentIndex++
1948-
1949-
# Clear screen and show progress
1946+
foreach ($script in $sortedScripts)
1947+
{
1948+
$currentIndex++ # Clear screen and show progress
19501949
Clear-Host
19511950
Write-Host "[$currentIndex/$totalCount] " -NoNewline -ForegroundColor Green
19521951
Write-Host $script.Name -ForegroundColor Cyan

‎ColorScripts-Enhanced/en-US/Add-ColorScriptProfile.md‎

Lines changed: 128 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
---
1+
---
2+
document type: cmdlet
23
external help file: ColorScripts-Enhanced-help.xml
4+
HelpUri: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
35
Module Name: ColorScripts-Enhanced
4-
online version: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
5-
schema: 2.0.0
6+
ms.date: 10/26/2025
7+
PlatyPS schema version: 2024-05-01
68
---
79

810
# Add-ColorScriptProfile
@@ -16,15 +18,26 @@ Appends the ColorScripts-Enhanced module import (and optionally Show-ColorScript
1618
### Scope (Default)
1719

1820
```
19-
Add-ColorScriptProfile [-Scope <String>] [-SkipStartupScript] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
21+
Add-ColorScriptProfile [-Scope <String>] [-SkipStartupScript] [-Force] [-WhatIf] [-Confirm]
22+
[<CommonParameters>]
2023
```
2124

2225
### Path
2326

2427
```
25-
Add-ColorScriptProfile [-Path <String>] [-SkipStartupScript] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
28+
Add-ColorScriptProfile [-Path <String>] [-SkipStartupScript] [-Force] [-WhatIf] [-Confirm]
29+
[<CommonParameters>]
30+
```
31+
32+
### __AllParameterSets
33+
34+
```
35+
Add-ColorScriptProfile [[-Scope] <string>] [[-Path] <string>] [-SkipStartupScript] [-Force]
36+
[-WhatIf] [-Confirm] [<CommonParameters>]
2637
```
2738

39+
## ALIASES
40+
2841
## DESCRIPTION
2942

3043
Adds a startup snippet to the specified PowerShell profile file. The snippet always imports the ColorScripts-Enhanced module and, unless suppressed, adds a call to `Show-ColorScript` so that a random colorscript is displayed on launch. The profile file is created if it does not already exist, and duplicate imports are avoided unless `-Force` is specified.
@@ -67,105 +80,150 @@ Appends the snippet to a custom profile path (resolved from `~`), even if the im
6780

6881
## PARAMETERS
6982

70-
### -Force
83+
### -Confirm
7184

72-
Append the snippet even if the profile already contains an `Import-Module ColorScripts-Enhanced` line.
85+
Prompts you for confirmation before running the cmdlet.
7386

7487
```yaml
75-
Type: SwitchParameter
76-
Parameter Sets: (All)
88+
Type: System.Management.Automation.SwitchParameter
89+
DefaultValue: False
90+
SupportsWildcards: false
7791
Aliases:
92+
- cf
93+
ParameterSets:
94+
- Name: (All)
95+
Position: Named
96+
IsRequired: false
97+
ValueFromPipeline: false
98+
ValueFromPipelineByPropertyName: false
99+
ValueFromRemainingArguments: false
100+
DontShow: false
101+
AcceptedValues: []
102+
HelpMessage: ''
103+
```
104+
105+
### -Force
106+
107+
Append the snippet even if the profile already contains an `Import-Module ColorScripts-Enhanced` line.
78108

79-
Required: False
80-
Position: Named
81-
Default value: False
82-
Accept pipeline input: False
83-
Accept wildcard characters: False
109+
```yaml
110+
Type: System.Management.Automation.SwitchParameter
111+
DefaultValue: False
112+
SupportsWildcards: false
113+
Aliases: []
114+
ParameterSets:
115+
- Name: (All)
116+
Position: Named
117+
IsRequired: false
118+
ValueFromPipeline: false
119+
ValueFromPipelineByPropertyName: false
120+
ValueFromRemainingArguments: false
121+
DontShow: false
122+
AcceptedValues: []
123+
HelpMessage: ''
84124
```
85125

86126
### -Path
87127

88128
Explicit profile path to update. Overrides `-Scope` when provided. Supports environment variables, relative paths, and `~` expansion.
129+
Explicit profile path to update.
130+
Overrides `-Scope` when provided.
131+
Supports environment variables, relative paths, and `~` expansion.
89132

90133
```yaml
91-
Type: String
92-
Parameter Sets: Path
93-
Aliases:
94-
95-
Required: False
96-
Position: Named
97-
Default value: None
98-
Accept pipeline input: False
99-
Accept wildcard characters: False
134+
Type: System.String
135+
DefaultValue: None
136+
SupportsWildcards: false
137+
Aliases: []
138+
ParameterSets:
139+
- Name: (All)
140+
Position: 1
141+
IsRequired: false
142+
ValueFromPipeline: false
143+
ValueFromPipelineByPropertyName: false
144+
ValueFromRemainingArguments: false
145+
DontShow: false
146+
AcceptedValues: []
147+
HelpMessage: ''
100148
```
101149

102150
### -Scope
103151

104152
Profile scope to update when `-Path` is not supplied. Accepts PowerShell's standard profile properties (e.g., `CurrentUserAllHosts`, `CurrentUserCurrentHost`). Defaults to `CurrentUserAllHosts`.
153+
Profile scope to update when `-Path` is not supplied.
154+
Accepts PowerShell's standard profile properties (e.g., `CurrentUserAllHosts`, `CurrentUserCurrentHost`).
155+
Defaults to `CurrentUserAllHosts`.
105156

106157
```yaml
107-
Type: String
108-
Parameter Sets: Scope
109-
Aliases:
110-
111-
Required: False
112-
Position: Named
113-
Default value: CurrentUserAllHosts
114-
Accept pipeline input: False
115-
Accept wildcard characters: False
158+
Type: System.String
159+
DefaultValue: CurrentUserAllHosts
160+
SupportsWildcards: false
161+
Aliases: []
162+
ParameterSets:
163+
- Name: (All)
164+
Position: 0
165+
IsRequired: false
166+
ValueFromPipeline: false
167+
ValueFromPipelineByPropertyName: false
168+
ValueFromRemainingArguments: false
169+
DontShow: false
170+
AcceptedValues: []
171+
HelpMessage: ''
116172
```
117173

118174
### -SkipStartupScript
119175

120176
Skip adding `Show-ColorScript` to the profile. Only the import line is appended.
177+
Skip adding `Show-ColorScript` to the profile.
178+
Only the import line is appended.
121179

122180
```yaml
123-
Type: SwitchParameter
124-
Parameter Sets: (All)
125-
Aliases:
126-
127-
Required: False
128-
Position: Named
129-
Default value: False
130-
Accept pipeline input: False
131-
Accept wildcard characters: False
132-
```
133-
134-
### -Confirm
135-
136-
Prompts you for confirmation before running the cmdlet.
137-
138-
```yaml
139-
Type: SwitchParameter
140-
Parameter Sets: (All)
141-
Aliases: cf
142-
143-
Required: False
144-
Position: Named
145-
Default value: False
146-
Accept pipeline input: False
147-
Accept wildcard characters: False
181+
Type: System.Management.Automation.SwitchParameter
182+
DefaultValue: False
183+
SupportsWildcards: false
184+
Aliases: []
185+
ParameterSets:
186+
- Name: (All)
187+
Position: Named
188+
IsRequired: false
189+
ValueFromPipeline: false
190+
ValueFromPipelineByPropertyName: false
191+
ValueFromRemainingArguments: false
192+
DontShow: false
193+
AcceptedValues: []
194+
HelpMessage: ''
148195
```
149196

150197
### -WhatIf
151198

152199
Shows what would happen if the cmdlet runs. The cmdlet is not run.
200+
Shows what would happen if the cmdlet runs.
201+
The cmdlet is not run.
153202

154203
```yaml
155-
Type: SwitchParameter
156-
Parameter Sets: (All)
204+
Type: System.Management.Automation.SwitchParameter
205+
DefaultValue: False
206+
SupportsWildcards: false
157207
Aliases:
158-
159-
Required: False
160-
Position: Named
161-
Default value: False
162-
Accept pipeline input: False
163-
Accept wildcard characters: False
208+
- wi
209+
ParameterSets:
210+
- Name: (All)
211+
Position: Named
212+
IsRequired: false
213+
ValueFromPipeline: false
214+
ValueFromPipelineByPropertyName: false
215+
ValueFromRemainingArguments: false
216+
DontShow: false
217+
AcceptedValues: []
218+
HelpMessage: ''
164219
```
165220

166221
### CommonParameters
167222

168-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
223+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
224+
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
225+
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
226+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
169227

170228
## INPUTS
171229

@@ -189,7 +247,7 @@ The profile file is created automatically if it does not exist. Duplicate import
189247

190248
## RELATED LINKS
191249

192-
[Show-ColorScript](Show-ColorScript.md)
193-
[Build-ColorScriptCache](Build-ColorScriptCache.md)
194-
[Clear-ColorScriptCache](Clear-ColorScriptCache.md)
195-
[Online Documentation](https://github.com/Nick2bad4u/ps-color-scripts-enhanced)
250+
- [Show-ColorScript](Show-ColorScript.md)
251+
- [Build-ColorScriptCache](Build-ColorScriptCache.md)
252+
- [Clear-ColorScriptCache](Clear-ColorScriptCache.md)
253+
- [Online Documentation](https://github.com/Nick2bad4u/ps-color-scripts-enhanced)

0 commit comments

Comments
 (0)