Allowing Markdown Help sections to be hidden (Fixes #124)

StartAutomating · May 26, 2023 · 3fd86aa · 3fd86aa
1 parent 7308f5f
commit 3fd86aa
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/Formatting/PowerShell.Markdown.Help.format.ps1 b/Formatting/PowerShell.Markdown.Help.format.ps1
@@ -322,9 +322,11 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co
 
         $sectionCounter = 0
         foreach ($sectionName in $orderOfSections) {
+
             $sectionCounter++
             $sectionContent =
-                if ($MarkdownSections.$sectionName -is [ScriptBlock]) {
+                if ($MarkdownSections.$sectionName -is [ScriptBlock] -and 
+                    $helpObject.HideSections -notcontains $sectionName) {
                     & $MarkdownSections.$sectionName
                 } else { $null }
             if ($sectionContent) {

diff --git a/Types/PowerShell.Markdown.Help/HideSection.ps1 b/Types/PowerShell.Markdown.Help/HideSection.ps1
@@ -0,0 +1,24 @@
+<#
+.SYNOPSIS
+    Hides sections of markdown help
+.DESCRIPTION
+    Hides sections of a command's markdown help.
+#>
+param(
+# One or more section names.
+[ValidateSet('Name','Synopsis','Description','RelatedLinks','Examples','Parameters','Inputs','Outputs','Notes','Story','Syntax')]
+[Alias('SectionName')]
+[string[]]
+$SectionNames
+)
+
+
+$skipSectionNames = @($This.HideSections)
+foreach ($SectionName in $SectionNames) {
+    if ($skipSectionNames -notcontains $SectionName) {     
+        $skipSectionNames += $SectionName 
+    }
+}
+
+$this | 
+    Add-Member NoteProperty HideSections $skipSectionNames -Force