HelpOut
0.4.3
A Helpful Toolkit for Managing PowerShell Help
Installation Options
Owners
Copyright
2019-2023 Start-Automating
Package Details
Author(s)
- James Brundage
Tags
Dependencies
This module has no dependencies.
Release Notes
### 0.4.3
* Action Improvements:
* Not obeying -InstallModule if a local module is found (Fixes #113)
* Not adding files found outside of the workspace (Fixes #114)
* Checking for detached branch before pulling (Fixes #103)
---
### 0.4.2
* Markdown Help Improvements:
* Adding Aliases (Fixes #111)
* Removing Horizontal Rule between parameters (Fixes #110)
* Adding newline before and after each section
* Supporting Script Stories (Fixes #104)
* [Ordered] Synopsis and Description (Fixes #107)
* Sorting front matter by Position (descending) and Name (Fixes #107)
* Moving Syntax below Notes and Story (re #104)
* Get-ScriptStory:
* Defaulting -HeadingSize to 3
* Action Improvements:
* Better Terminal Output / Removing Output Variables (Fixes #109)
* Improving branchless error behavior (Fixes #103)
* Adding -InstallModule (Fixes #108)
---
### 0.4.1
* Parameter Properties are now rendered as a table (Fixes #98)
* Save-MarkdownHelp: Adding -ExcludeFile (Fixes #97)
---
### 0.4
* Get/Save-MarkdownHelp:
* Adding -YamlHeaderInformationType and including [Reflection.AssemblyMetaData] attributes (Fixes #93)
* Replacing anchor links with lowercase (Fixes #92)
* Returning unmodified files when no link is replaced (Fixes #91)
---
### 0.3.9
* No longer attempting to repair links if the file is not markdown (Fixes #88)
---
### 0.3.8
* YAML Header is now optional (with -IncludeYamlHeader) (Fixes #80)
* Save-MarkdownHelp trims content (Fixes #85)
---
### 0.3.7
All Markdown help now includes a YAML Header unless -NoYAMLHeader is passed (Fixes #80)
---
### 0.3.6
* Improvements to [OutputType] support (Fixes #78)
* GitHub Action No Longer Runs when not on a branch (Fixes #77)
---
### 0.3.5
* Markdown Help Improvements: Escaping Example Code (Fixes #75)
---
### 0.3.4
* Fixing accidental heading names in .Link and parameter properties (Fixes #73)
---
### 0.3.3
* Markdown Help now uses fewer tables (improves default GitHub Page rendering) (fixes #71)
---
### 0.3.2
* Save-MarkdownHelp Bugfix (Fixes #69)
---
### 0.3.1
* Save-MarkdownHelp:
* Can now -ReplaceLink (Fixes #66)
* -ReplaceLink will always replace -OutputPath (Fixes #67)
* Changing Aliases for -SkipCommandType (Fixes #65)
---
### 0.3:
* Get-MarkdownHelp: Fixing Property Table rendering issues with ValidValues (#58)
* Workflow improvements: Building formatting / types in CI/CD (#63)
---
### 0.2.9:
* Get-MarkdownHelp: Fixing Property Table rendering issues with ValidValues (#58)
* Action improvements:
* Pulling just before push (#59)
* Improving username / email detection (#60)
---
### 0.2.8:
* Save-MarkdownHelp:
* Adding -ExcludeTopic (#55)
* -IncludeTopic excludes deeply nested topics (#54)
* -IncludeExtension default now includes .svg files (#53)
---
### 0.2.7
* Save-MarkdownHelp:
* Adding -Command, -ReplaceCommandName, -ReplaceCommandNameWith (#45)
* Fixing -ReplaceScriptName issue (#46)
* Save-MAML:
* -PassThru now returns files, not file contents (#47)
* HelpOut.HelpOut.ps1 Added (Selfhosting Action (#48))
---
### 0.2.6
* Save-MarkdownHelp:
* Improving Inline Documentation
* Allowing -ScriptPath to be a Regex (#41)
* Fixing Relative Paths with -IncludeExtension (#42)
* Improving -IncludeTopic regex behavior (#43)
---
### 0.2.5
* Save-MarkdownHelp:
* Adding -IncludeExtension (#35)
* Applying -PassThru to -IncludeTopic (#34)
* Allowing wildcards in -IncludeTopic (#33)
* Preliminary support for GitHub Pages Publishing (#32)
---
### 0.2.4
* Save-MarkdownHelp:
* Adding -SkipCommandType (#29)
* -ScriptPath now allows wildcards (#28)
* Formatting now Handles Arrays of Enums (#30)
---
### 0.2.3
* Get/Save-MarkdownHelp: Support for -NoValidValueEnumeration (re #25)
* Save-MarkdownHelp: Adding -IncludeTopic (Fixes #24, #26)
* Adding ValidateSet/Enum Formatting for Markdown Help (Fixing #25)
---
### 0.2.2
* Fixing issue generating docs (#22)
* HelpOut Action Fix (#20)
---
### 0.2.1
* Get/Save-MarkdownHelp: Support for -SectionOrder (#19)
* Save-MarkdownHelp: Adding -Passthru (#17). Converting Markdown Help into a string (#18)
* Get-MarkdownHelp: Returning Object (#18)
* Fixing URL-only related links (#14)
* Adding Get-MarkdownHelp -Rename (#13)
* Retitling Script Files with relative path (#12)
---
### 0.2
* Adding Install-MAML (#1/ #7)
* Adding Get-MarkdownHelp (#4)
* Adding Save-MarkdownHelp (#10)
* Adding HelpOut Action (#5)
* Adding Measure-Help (#11)
* Adding Get-ScriptStory (#3)
* Adding Get-ScriptReference (#2)
* Renmaing ConvertTo-MAML->Get-MAML
---
FileList
- HelpOut.nuspec
- README.md
- docs\2022-10-01.md
- HelpOut.ezout.ps1
- docs\2022-06.md
- HelpOut.psm1
- docs\CNAME
- Install-MAML.ps1
- docs\2023-02-20.md
- Get-ScriptStory.ps1
- docs\CHANGELOG.md
- allcommands.ps1
- docs\2022-04.md
- Get-MAML.ps1
- docs\2022-09-11.md
- Get-ScriptReference.ps1
- docs\2022-07.md
- Save-MarkdownHelp.ps1
- docs\2022-08-28.md
- LICENSE
- docs\ConvertTo-MAML.md
- HelpOut-Help.xml
- docs\2022-10-26.md
- HelpOut.format.ps1xml
- docs\Save-MarkdownHelp.md
- HelpOut.GitHubWorkflow.PSDevOps.ps1
- docs\Get-MAML.md
- docs\Install-MAML.md
- CHANGELOG.md
- docs\2022-04-22.md
- HelpOut.tests.ps1
- docs\2022-11.md
- HelpOut.psd1
- docs\Save-MAML.md
- action.yml
- docs\2022-07-18.md
- HelpOut.HelpOut.ps1
- docs\2022-09.md
- Get-MarkdownHelp.ps1
- en-us\HelpOut-Help.xml
- HelpOut.GitHubAction.PSDevOps.ps1
- en-us\About_HelpOut.help.txt
- Save-MAML.ps1
- Formatting\PowerShell.Markdown.Help.format.ps1
- Measure-Help.ps1
- Formatting\Documentation.Percentage.format.ps1
- docs\README.md
- GitHub\Jobs\BuildHelpOut.psd1
- docs\2023-02.md
- GitHub\Actions\HelpOutAction.ps1
- docs\Measure-Help.md
- docs\_posts\2022-07-31-HelpOut-0.3.md
- docs\2023-01-07.md
- docs\_posts\2022-05-03-HelpOut-0.2.3.md
- docs\2022-04-23.md
- docs\_posts\2022-06-08-HelpOut-0.2.5.md
- docs\2022-10.md
- docs\_posts\2022-07-18-HelpOut-0.2.8.md
- docs\2022-11-04.md
- docs\_posts\2022-04-22-HelpOut-0.2.md
- docs\2022-04-26.md
- docs\_posts\2022-10-28-HelpOut-0.3.9.md
- docs\2022.md
- docs\_posts\2023-01-07-HelpOut-0.4.1.md
- docs\2022-10-28.md
- docs\_posts\2022-07-31-HelpOut-0.2.9.md
- docs\2022-05-03.md
- docs\_posts\2022-09-11-HelpOut-0.3.3.md
- docs\2023-01.md
- docs\_posts\2022-10-01-HelpOut-0.3.6.md
- docs\2023.md
- docs\_posts\2022-09-11-HelpOut-0.3.4.md
- docs\Get-MarkdownHelp.md
- docs\_posts\2022-10-26-HelpOut-0.3.8.md
- docs\rss.xml
- docs\_posts\2022-06-21-HelpOut-0.2.6.md
- docs\2022-07-06.md
- docs\_posts\2022-08-21-HelpOut-0.3.1.md
- docs\2022-08.md
- docs\_posts\2022-08-28-HelpOut-0.3.2.md
- docs\2022-05.md
- docs\_posts\2023-02-20-HelpOut-0.4.2.md
- docs\2022-09-12.md
- docs\_posts\2022-11-04-HelpOut-0.4.md
- docs\Get-ScriptStory.md
- docs\_posts\2022-04-23-HelpOut-0.2.1.md
- docs\2022-07-31.md
- docs\_posts\2022-09-12-HelpOut-0.3.5.md
- docs\2022-08-21.md
- docs\_posts\2022-10-26-HelpOut-0.3.7.md
- docs\2022-06-21.md
- docs\_posts\2022-04-26-HelpOut-0.2.2.md
- docs\Get-ScriptReference.md
- docs\_posts\2022-07-06-HelpOut-0.2.7.md
- docs\2022-06-08.md
- docs\_posts\2022-06-08-HelpOut-0.2.4.md
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 0.5.5 | 1,391 | 10/13/2024 |
| 0.5.4 | 5 | 10/12/2024 |
| 0.5.3 | 493 | 3/16/2024 |
| 0.5.2 | 317 | 1/27/2024 |
| 0.5.1 | 1,001 | 11/17/2023 |
| 0.5 | 174 | 10/5/2023 |
| 0.4.9 | 14 | 9/26/2023 |
| 0.4.8 | 16 | 9/20/2023 |
| 0.4.7 | 118 | 6/4/2023 |
| 0.4.6 | 8 | 6/4/2023 |
| 0.4.5 | 15 | 5/26/2023 |
| 0.4.4 | 43 | 3/27/2023 |
| 0.4.3 (current version) | 13 | 3/9/2023 |
| 0.4.2 | 14 | 2/20/2023 |
| 0.4.1 | 20 | 1/7/2023 |
| 0.4 | 37 | 11/4/2022 |
| 0.3.9 | 18 | 10/28/2022 |
| 0.3.8 | 14 | 10/26/2022 |
| 0.3.7 | 13 | 10/26/2022 |
| 0.3.6 | 19 | 10/1/2022 |
| 0.3.5 | 21 | 9/12/2022 |
| 0.3.4 | 13 | 9/11/2022 |
| 0.3.3 | 13 | 9/11/2022 |
| 0.3.2 | 14 | 8/28/2022 |
| 0.3.1 | 17 | 8/21/2022 |
| 0.3 | 21 | 7/31/2022 |
| 0.2.9 | 13 | 7/31/2022 |
| 0.2.8 | 22 | 7/18/2022 |
| 0.2.7 | 20 | 7/6/2022 |
| 0.2.6 | 19 | 6/21/2022 |
| 0.2.5 | 27 | 6/8/2022 |
| 0.2.4 | 13 | 6/8/2022 |
| 0.2.3 | 26 | 5/3/2022 |
| 0.2.2 | 24 | 4/26/2022 |
| 0.2.1 | 15 | 4/23/2022 |
| 0.2 | 17 | 4/22/2022 |
| 0.1 | 357 | 6/18/2019 |