diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Compare-CommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Compare-CommandHelp.md index 1bb525e..44d558c 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Compare-CommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Compare-CommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/compare-commandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/compare-commandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Compare-CommandHelp --- @@ -24,6 +24,8 @@ Compare-CommandHelp [-ReferenceCommandHelp] [-DifferenceCommandHel [-PropertyNamesToExclude ] [] ``` +## ALIASES + ## DESCRIPTION `Compare-CommandHelp` is a troubleshooting tool that compares two CommandHelp objects and produces a @@ -48,14 +50,19 @@ The CommandHelp object to compare against the reference object. ```yaml Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: true + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -PropertyNamesToExclude @@ -64,14 +71,19 @@ A list of one or more property names to exclude from the comparison. ```yaml Type: System.String[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -ReferenceCommandHelp @@ -80,14 +92,19 @@ The base CommandHelp object to be compared to the difference object. ```yaml Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: true + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -109,6 +126,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md) - -[Import-YamlCommandHelp](Import-YamlCommandHelp.md) +- [Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md) +- [Import-YamlCommandHelp](Import-YamlCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MamlCommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MamlCommandHelp.md index 13d6bb6..fc41fbf 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MamlCommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MamlCommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-mamlcommandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-mamlcommandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Export-MamlCommandHelp --- @@ -24,6 +24,8 @@ Export-MamlCommandHelp [-CommandHelp] [-OutputFolder] [-Encoding ] [-Force] [-WhatIf] [-Confirm] [] ``` +## ALIASES + ## DESCRIPTION This command converts **CommandHelp** objects to a MAML file. The MAML file contains help content in @@ -56,14 +58,19 @@ One or more **CommandHelp** objects to export. ```yaml Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Confirm @@ -72,14 +79,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Encoding @@ -89,14 +102,19 @@ the value of the `$OutputEncoding` preference variable. ```yaml Type: System.Text.Encoding -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Force @@ -105,14 +123,19 @@ Use the **Force** parameter to overwrite the output file if it already exists. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -OutputFolder @@ -121,30 +144,41 @@ The folder where the markdown file is saved. If the folder doesn't exist, it's c ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet isn't run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -156,7 +190,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.PowerShell.PlatyPS.Model.CommandHelp +### Microsoft.PowerShell.PlatyPS.Model.CommandHelp[] ## OUTPUTS @@ -166,4 +200,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md) +- [Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MarkdownCommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MarkdownCommandHelp.md index fe1d6e6..d8674b0 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MarkdownCommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MarkdownCommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-markdowncommandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-markdowncommandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Export-MarkdownCommandHelp --- @@ -24,6 +24,8 @@ Export-MarkdownCommandHelp [-CommandHelp] [-Encoding ] [-OutputFolder ] [-Metadata ] [-WhatIf] [-Confirm] [] ``` +## ALIASES + ## DESCRIPTION This command exports a **CommandHelp** object to a markdown file. You can add metadata frontmatter @@ -99,14 +101,19 @@ using the **Command** parameter. ```yaml Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Confirm @@ -115,14 +122,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Encoding @@ -132,14 +145,19 @@ the value of the `$OutputEncoding` preference variable. ```yaml Type: System.Text.Encoding -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Force @@ -148,14 +166,19 @@ Use the **Force** parameter to overwrite the output file if it already exists. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Metadata @@ -166,14 +189,19 @@ existing frontmatter. The values of existing keys are overwritten. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -OutputFolder @@ -182,30 +210,41 @@ The folder where the markdown file is saved. If the folder doesn't exist, it's c ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -217,7 +256,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.PowerShell.PlatyPS.Model.CommandHelp +### Microsoft.PowerShell.PlatyPS.Model.CommandHelp[] ## OUTPUTS @@ -227,8 +266,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Export-YamlCommandHelp](Export-YamlCommandHelp.md) - -[Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md) - -[Import-YamlCommandHelp](Import-YamlCommandHelp.md) +- [Export-YamlCommandHelp](Export-YamlCommandHelp.md) +- [Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md) +- [Import-YamlCommandHelp](Import-YamlCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MarkdownModuleFile.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MarkdownModuleFile.md index f4eb9ad..46c5019 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MarkdownModuleFile.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-MarkdownModuleFile.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-markdownmodulefile?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-markdownmodulefile?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Export-MarkdownModuleFile --- @@ -24,6 +24,8 @@ Export-MarkdownModuleFile [-ModuleFileInfo] [-Encoding ] [-OutputFolder ] [-WhatIf] [-Confirm] [] ``` +## ALIASES + ## DESCRIPTION This command exports a **ModuleFileInfo** object to a markdown file. You can add metadata @@ -60,14 +62,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Encoding @@ -77,14 +85,19 @@ the value of the `$OutputEncoding` preference variable. ```yaml Type: System.Text.Encoding -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Force @@ -93,14 +106,19 @@ Use the **Force** parameter to overwrite the output file if it already exists. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Metadata @@ -111,14 +129,19 @@ existing frontmatter. The values of existing keys are overwritten. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -ModuleFileInfo @@ -128,14 +151,19 @@ The **ModuleFileInfo** object to export to a markdown file. This object is creat ```yaml Type: Microsoft.PowerShell.PlatyPS.ModuleFileInfo[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -OutputFolder @@ -144,30 +172,41 @@ The folder where the markdown file is saved. If the folder doesn't exist, it's c ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet isn't run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -179,7 +218,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.PowerShell.PlatyPS.ModuleFileInfo +### Microsoft.PowerShell.PlatyPS.ModuleFileInfo[] ## OUTPUTS @@ -189,4 +228,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Import-MarkdownModuleFile](Import-MarkdownModuleFile.md) +- [Import-MarkdownModuleFile](Import-MarkdownModuleFile.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-YamlCommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-YamlCommandHelp.md index fa2fc5a..6dddc99 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-YamlCommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-YamlCommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-yamlcommandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-yamlcommandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Export-YamlCommandHelp --- @@ -24,6 +24,8 @@ Export-YamlCommandHelp [-CommandHelp] [-Encoding ] [-F [-OutputFolder ] [-Metadata ] [-WhatIf] [-Confirm] [] ``` +## ALIASES + ## DESCRIPTION This command exports a **CommandHelp** object to a Yaml file. You can add metadata frontmatter @@ -79,14 +81,19 @@ using the **Command** parameter. ```yaml Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Confirm @@ -95,14 +102,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Encoding @@ -112,14 +125,19 @@ the value of the `$OutputEncoding` preference variable. ```yaml Type: System.Text.Encoding -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Force @@ -128,14 +146,19 @@ Use the **Force** parameter to overwrite the output file if it already exists. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Metadata @@ -146,14 +169,19 @@ existing frontmatter. The values of existing keys are overwritten. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -OutputFolder @@ -162,30 +190,41 @@ The folder where the markdown file is saved. If the folder doesn't exist, it's c ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet isn't run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -197,7 +236,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.PowerShell.PlatyPS.Model.CommandHelp +### Microsoft.PowerShell.PlatyPS.Model.CommandHelp[] ## OUTPUTS @@ -207,10 +246,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Export-YamlCommandHelp](Export-YamlCommandHelp.md) - -[Export-MarkdownCommandHelp](Export-MarkdownCommandHelp.md) - -[Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md) - -[Import-YamlCommandHelp](Import-YamlCommandHelp.md) +- [Export-YamlCommandHelp](Export-YamlCommandHelp.md) +- [Export-MarkdownCommandHelp](Export-MarkdownCommandHelp.md) +- [Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md) +- [Import-YamlCommandHelp](Import-YamlCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-YamlModuleFile.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-YamlModuleFile.md index 0f7457f..0d138e8 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-YamlModuleFile.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Export-YamlModuleFile.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-yamlmodulefile?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-yamlmodulefile?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Export-YamlModuleFile --- @@ -24,6 +24,8 @@ Export-YamlModuleFile [-ModuleFileInfo] [-Encoding [-OutputFolder ] [-Metadata ] [-WhatIf] [-Confirm] [] ``` +## ALIASES + ## DESCRIPTION This command exports a **ModuleFileInfo** object to a markdown file. You can get a @@ -58,14 +60,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Encoding @@ -75,14 +83,19 @@ the value of the `$OutputEncoding` preference variable. ```yaml Type: System.Text.Encoding -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Force @@ -91,14 +104,19 @@ Use the **Force** parameter to overwrite the output file if it already exists. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Metadata @@ -107,14 +125,19 @@ The metadata to add to the markdown file. The metadata is a hashtable that conta ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -ModuleFileInfo @@ -124,14 +147,19 @@ or by using the **ModuleFileInfo** parameter. ```yaml Type: Microsoft.PowerShell.PlatyPS.ModuleFileInfo[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -OutputFolder @@ -141,30 +169,41 @@ The **ModuleFileInfo** object to export to a markdown file. This object is creat ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet isn't run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -176,7 +215,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.PowerShell.PlatyPS.ModuleFileInfo +### Microsoft.PowerShell.PlatyPS.ModuleFileInfo[] ## OUTPUTS @@ -186,6 +225,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Export-MarkdownModuleFile](Export-MarkdownModuleFile.md) - -[Import-MarkdownModuleFile](Import-MarkdownModuleFile.md) +- [Export-MarkdownModuleFile](Export-MarkdownModuleFile.md) +- [Import-MarkdownModuleFile](Import-MarkdownModuleFile.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MamlHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MamlHelp.md index 75da556..66c5a74 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MamlHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MamlHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/import-mamlhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/import-mamlhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Import-MamlHelp --- @@ -29,6 +29,8 @@ Import-MamlHelp [-Path] [] Import-MamlHelp -LiteralPath [] ``` +## ALIASES + ## DESCRIPTION This command can be used to create **CommandHelp** objects from MAML help files. These objects can @@ -57,14 +59,21 @@ For more information, see ```yaml Type: System.String[] -Parameter Sets: LiteralPath +DefaultValue: None +SupportsWildcards: false Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +- PSPath +- LP +ParameterSets: +- Name: LiteralPath + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: true + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -73,14 +82,19 @@ The path to the MAML help file. Specifies a path to one or more locations. ```yaml Type: System.String[] -Parameter Sets: Path -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True +DefaultValue: None +SupportsWildcards: true +Aliases: [] +ParameterSets: +- Name: Path + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -92,7 +106,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.String +### System.String[] ## OUTPUTS @@ -106,4 +120,4 @@ is not a complete representation of the original command. ## RELATED LINKS -[Export-MamlHelp](Export-MamlCommandHelp.md) +- [Export-MamlHelp](Export-MamlCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MarkdownCommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MarkdownCommandHelp.md index c908e34..c5b2afe 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MarkdownCommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MarkdownCommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/import-markdowncommandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/import-markdowncommandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Import-MarkdownCommandHelp --- @@ -29,6 +29,8 @@ Import-MarkdownCommandHelp [-Path] [] Import-MarkdownCommandHelp -LiteralPath [] ``` +## ALIASES + ## DESCRIPTION The command imports Markdown files containing command help and creates **CommandHelp** objects. The @@ -87,14 +89,21 @@ For more information, see ```yaml Type: System.String[] -Parameter Sets: LiteralPath +DefaultValue: None +SupportsWildcards: false Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +- PSPath +- LP +ParameterSets: +- Name: LiteralPath + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -107,14 +116,19 @@ items in the current location. ```yaml Type: System.String[] -Parameter Sets: Path -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True +DefaultValue: None +SupportsWildcards: true +Aliases: [] +ParameterSets: +- Name: Path + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -126,7 +140,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.String +### System.String[] ## OUTPUTS @@ -136,8 +150,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Export-MarkdownCommandHelp](Export-MarkdownCommandHelp.md) - -[Export-YamlCommandHelp](Export-YamlCommandHelp.md) - -[Import-YamlCommandHelp](Import-YamlCommandHelp.md) +- [Export-MarkdownCommandHelp](Export-MarkdownCommandHelp.md) +- [Export-YamlCommandHelp](Export-YamlCommandHelp.md) +- [Import-YamlCommandHelp](Import-YamlCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MarkdownModuleFile.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MarkdownModuleFile.md index 2e902a9..38f165b 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MarkdownModuleFile.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-MarkdownModuleFile.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/import-markdownmodulefile?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/import-markdownmodulefile?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Import-MarkdownModuleFile --- @@ -29,6 +29,8 @@ Import-MarkdownModuleFile [-Path] [] Import-MarkdownModuleFile -LiteralPath [] ``` +## ALIASES + ## DESCRIPTION The command imports Markdown files containing module help and creates **ModuleHelp** objects. The @@ -69,14 +71,21 @@ For more information, see ```yaml Type: System.String[] -Parameter Sets: LiteralPath +DefaultValue: None +SupportsWildcards: false Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +- PSPath +- LP +ParameterSets: +- Name: LiteralPath + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -89,14 +98,19 @@ items in the current location. ```yaml Type: System.String[] -Parameter Sets: Path -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True +DefaultValue: None +SupportsWildcards: true +Aliases: [] +ParameterSets: +- Name: Path + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -108,7 +122,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.String +### System.String[] ## OUTPUTS @@ -118,8 +132,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Export-MarkdownModuleFile](Export-MarkdownModuleFile.md) - -[Export-YamlModuleFile](Export-YamlModuleFile.md) - -[Import-MarkdownModuleFile](Import-MarkdownModuleFile.md) +- [Export-MarkdownModuleFile](Export-MarkdownModuleFile.md) +- [Export-YamlModuleFile](Export-YamlModuleFile.md) +- [Import-MarkdownModuleFile](Import-MarkdownModuleFile.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-YamlCommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-YamlCommandHelp.md index 3829dd7..0db1e12 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-YamlCommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-YamlCommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/import-yamlcommandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/import-yamlcommandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Import-YamlCommandHelp --- @@ -29,6 +29,8 @@ Import-YamlCommandHelp [-Path] [-AsDictionary] [] Import-YamlCommandHelp -LiteralPath [-AsDictionary] [] ``` +## ALIASES + ## DESCRIPTION The command imports Yaml files containing command help and creates **CommandHelp** objects. The @@ -79,14 +81,19 @@ returns the same information as an **OrderedDictionary** object. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -LiteralPath @@ -101,14 +108,21 @@ For more information, see ```yaml Type: System.String[] -Parameter Sets: LiteralPath +DefaultValue: None +SupportsWildcards: false Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +- PSPath +- LP +ParameterSets: +- Name: LiteralPath + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -117,14 +131,20 @@ The path to the Yaml command file. Specifies a path to one or more locations. ```yaml Type: System.String[] -Parameter Sets: Path -Aliases: FullName -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True +DefaultValue: None +SupportsWildcards: true +Aliases: +- FullName +ParameterSets: +- Name: Path + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: true + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -136,7 +156,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.String +### System.String[] ## OUTPUTS @@ -152,4 +172,4 @@ By default, this cmdlet returns **CommandHelp** objects. ## RELATED LINKS -[Export-YamlCommandHelp](Export-YamlCommandHelp.md) +- [Export-YamlCommandHelp](Export-YamlCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-YamlModuleFile.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-YamlModuleFile.md index 6fe49fb..8d65e6c 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-YamlModuleFile.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Import-YamlModuleFile.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/import-yamlmodulefile?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/import-yamlmodulefile?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Import-YamlModuleFile --- @@ -29,6 +29,8 @@ Import-YamlModuleFile [-Path] [-AsDictionary] [] Import-YamlModuleFile -LiteralPath [-AsDictionary] [] ``` +## ALIASES + ## DESCRIPTION The command imports Yaml files containing module help and creates **ModuleHelp** objects. The @@ -64,14 +66,19 @@ returns the **ModuleHelp** data a dictionary object. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -LiteralPath @@ -86,14 +93,21 @@ For more information, see ```yaml Type: System.String[] -Parameter Sets: LiteralPath +DefaultValue: None +SupportsWildcards: false Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +- PSPath +- LP +ParameterSets: +- Name: LiteralPath + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -102,14 +116,19 @@ Specifies a path to one or more locations containing Yaml module files. ```yaml Type: System.String[] -Parameter Sets: Path -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True +DefaultValue: None +SupportsWildcards: true +Aliases: [] +ParameterSets: +- Name: Path + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -121,7 +140,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.String +### System.String[] ## OUTPUTS @@ -131,4 +150,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Import-MarkdownModuleFile](Import-MarkdownModuleFile.md) +- [Import-MarkdownModuleFile](Import-MarkdownModuleFile.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Measure-PlatyPSMarkdown.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Measure-PlatyPSMarkdown.md index 76c2ba5..e096835 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Measure-PlatyPSMarkdown.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Measure-PlatyPSMarkdown.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/measure-platypsmarkdown?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/measure-platypsmarkdown?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Measure-PlatyPSMarkdown --- @@ -29,6 +29,8 @@ Measure-PlatyPSMarkdown [-Path] [] Measure-PlatyPSMarkdown -LiteralPath [] ``` +## ALIASES + ## DESCRIPTION The command reads the content of the file and determines the type of content. The command returns a @@ -83,14 +85,21 @@ For more information, see ```yaml Type: System.String[] -Parameter Sets: LiteralPath +DefaultValue: None +SupportsWildcards: false Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False +- PSPath +- LP +ParameterSets: +- Name: LiteralPath + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -99,14 +108,19 @@ The path to one or more Markdown files. Specifies a path to one or more location ```yaml Type: System.String[] -Parameter Sets: Path -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True +DefaultValue: None +SupportsWildcards: true +Aliases: [] +ParameterSets: +- Name: Path + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -118,7 +132,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.String +### System.String[] ## OUTPUTS @@ -135,4 +149,4 @@ to validate the structure of the markdown file. ## RELATED LINKS -[Test-MarkdownCommandHelp](Test-MarkdownCommandHelp.md) +- [Test-MarkdownCommandHelp](Test-MarkdownCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Microsoft.PowerShell.PlatyPS.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Microsoft.PowerShell.PlatyPS.md index 3de36aa..30041b7 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Microsoft.PowerShell.PlatyPS.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Microsoft.PowerShell.PlatyPS.md @@ -1,12 +1,12 @@ --- -Download Help Link: https://aka.ms/ps-modules-help +document type: module Help Version: 1.0.0 +HelpInfoUri: https://aka.ms/ps-modules-help Locale: en-US Module Guid: 0bdcabef-a4b7-4a6d-bf7e-d879817ebbff Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/26/2024 -schema: 2.0.0 +ms.date: 07/18/2025 +PlatyPS schema version: 2024-05-01 title: Microsoft.PowerShell.PlatyPS Module --- diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-CommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-CommandHelp.md index 529577d..5c0ca37 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-CommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-CommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/new-commandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/new-commandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: New-CommandHelp --- @@ -23,6 +23,8 @@ Creates **CommandHelp** objects for a PowerShell command that's loaded in the se New-CommandHelp [-CommandInfo] [] ``` +## ALIASES + ## DESCRIPTION This cmdlet takes a list of one or more PowerShell commands and creates **CommandHelp** objects for @@ -82,14 +84,19 @@ A list of one or more PowerShell commands (cmdlets, functions, scripts). The cmd ```yaml Type: System.Management.Automation.CommandInfo[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -101,7 +108,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.Management.Automation.CommandInfo +### System.Management.Automation.CommandInfo[] ## OUTPUTS @@ -111,6 +118,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Export-MarkdownCommandHelp](Export-MarkdownCommandHelp.md) - -[Export-YamlCommandHelp](Export-YamlCommandHelp.md) +- [Export-MarkdownCommandHelp](Export-MarkdownCommandHelp.md) +- [Export-YamlCommandHelp](Export-YamlCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-HelpCabinetFile.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-HelpCabinetFile.md index c7212a4..ba4220f 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-HelpCabinetFile.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-HelpCabinetFile.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/new-helpcabinetfile?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/new-helpcabinetfile?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: New-HelpCabinetFile --- @@ -24,6 +24,8 @@ New-HelpCabinetFile [-CabinetFilesFolder] [-MarkdownModuleFile] [-WhatIf] [-Confirm] [] ``` +## ALIASES + ## DESCRIPTION This cmdlet create `.cab` and `.zip` files that contain help files for a module. @@ -59,14 +61,19 @@ The path to the folder containing the MAML file to be packaged. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Confirm @@ -75,14 +82,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -MarkdownModuleFile @@ -91,14 +104,19 @@ Specifies the full path of the module Markdown file. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -OutputFolder @@ -107,30 +125,41 @@ The location where you want to write the `.cab`, `.zip`, and `HelpInfo.xml` file ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 2 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet isn't run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-MarkdownCommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-MarkdownCommandHelp.md index 9e86c1c..8759f3e 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-MarkdownCommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-MarkdownCommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/new-markdowncommandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/new-markdowncommandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: New-MarkdownCommandHelp --- @@ -26,6 +26,8 @@ New-MarkdownCommandHelp -OutputFolder [-CommandInfo ] [- [-AbbreviateParameterTypename] [-WhatIf] [-Confirm] [] ``` +## ALIASES + ## DESCRIPTION Creates Markdown help files for PowerShell modules and commands. @@ -65,14 +67,19 @@ types. When you use this parameter, the cmdlet outputs short type names. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -CommandInfo @@ -81,14 +88,19 @@ A list of one or more commands to create help for. ```yaml Type: System.Management.Automation.CommandInfo[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Confirm @@ -97,14 +109,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Encoding @@ -114,14 +132,19 @@ by `$OutputEncoding`. ```yaml Type: System.Text.Encoding -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Force @@ -131,14 +154,19 @@ overwrites existing files. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -HelpInfoUri @@ -148,14 +176,19 @@ the HelpInfoUri specified in the module manifest. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -HelpUri @@ -165,14 +198,19 @@ URI defined in the `[CmdletBinding()]` attribute for the command. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -HelpVersion @@ -182,14 +220,19 @@ version is written to the `HelpInfo.xml` file that is used for updateable help. ```yaml Type: System.Version -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Locale @@ -200,14 +243,19 @@ on your system. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Metadata @@ -220,14 +268,19 @@ the cmdlet ignores the values and outputs a warning. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -ModuleInfo @@ -238,14 +291,19 @@ location. All Markdown files are written to the module folder. ```yaml Type: System.Management.Automation.PSModuleInfo[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -OutputFolder @@ -256,30 +314,41 @@ creates a the Markdown file in the root of the output folder. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet isn't run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WithModulePage @@ -290,14 +359,19 @@ the module and metadata used to create the HelpInfo.xml file. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -309,9 +383,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.Management.Automation.CommandInfo +### System.Management.Automation.CommandInfo[] -### System.Management.Automation.PSModuleInfo +### System.Management.Automation.PSModuleInfo[] ## OUTPUTS @@ -321,4 +395,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Export-MarkdownCommandHelp](Export-MarkdownCommandHelp.md) +- [Export-MarkdownCommandHelp](Export-MarkdownCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-MarkdownModuleFile.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-MarkdownModuleFile.md index 8b11427..2f3f1e4 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-MarkdownModuleFile.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/New-MarkdownModuleFile.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/new-markdownmodulefile?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/new-markdownmodulefile?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: New-MarkdownModuleFile --- @@ -20,11 +20,13 @@ Creates the Markdown module file for a PowerShell module. ### __AllParameterSets ``` -New-MarkdownModuleFile -OutputFolder [-CommandHelp ] [-Encoding ] - [-Force] [-HelpUri ] [-HelpInfoUri ] [-HelpVersion ] [-Locale ] - [-Metadata ] [-WhatIf] [-Confirm] [] +New-MarkdownModuleFile -OutputFolder [-CommandHelp ] + [-Encoding ] [-Force] [-HelpInfoUri ] [-HelpVersion ] + [-Locale ] [-Metadata ] [-WhatIf] [-Confirm] [] ``` +## ALIASES + ## DESCRIPTION This command creates the Markdown module file for a PowerShell module. The module file contains the @@ -79,14 +81,19 @@ object on the pipeline or by using the **Command** parameter. ```yaml Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Confirm @@ -95,14 +102,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Encoding @@ -112,14 +125,19 @@ by `$OutputEncoding`. ```yaml Type: System.Text.Encoding -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Force @@ -129,14 +147,19 @@ overwrites existing files. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -HelpInfoUri @@ -146,30 +169,19 @@ the HelpInfoUri specified in the module manifest. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HelpUri - -{{ Fill HelpUri Description }} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -HelpVersion @@ -179,14 +191,19 @@ version is written to the `HelpInfo.xml` file that is used for updateable help. ```yaml Type: System.Version -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Locale @@ -197,14 +214,19 @@ on your system. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Metadata @@ -217,14 +239,19 @@ the cmdlet ignores the values and outputs a warning. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -OutputFolder @@ -234,30 +261,41 @@ each module based on the **CommandHelp** object being processed. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet isn't run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -269,7 +307,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.PowerShell.PlatyPS.Model.CommandHelp +### Microsoft.PowerShell.PlatyPS.Model.CommandHelp[] ## OUTPUTS @@ -279,6 +317,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Export-MarkdownModuleFile](Export-MarkdownModuleFile.md) - -[Update-MarkdownModuleFile](Update-MarkdownModuleFile.md) +- [Export-MarkdownModuleFile](Export-MarkdownModuleFile.md) +- [Update-MarkdownModuleFile](Update-MarkdownModuleFile.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Show-HelpPreview.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Show-HelpPreview.md index 0fe940c..44319eb 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Show-HelpPreview.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Show-HelpPreview.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/show-helppreview?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/show-helppreview?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Show-HelpPreview --- @@ -31,6 +31,8 @@ Show-HelpPreview [-LiteralPath] [-ConvertNotesToList] [-ConvertDouble [] ``` +## ALIASES + ## DESCRIPTION The `Show-HelpPreview` cmdlet displays your generated external help as `Get-Help` output. Specify @@ -57,14 +59,19 @@ for lists. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -ConvertNotesToList @@ -74,14 +81,19 @@ items. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -LiteralPath @@ -90,14 +102,21 @@ Specifies one or more paths to MAML help files. Wildcards aren't supported. ```yaml Type: System.String[] -Parameter Sets: LiteralPath -Aliases: LP, PSPath -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: +- PSPath +- LP +ParameterSets: +- Name: LiteralPath + Position: 1 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -106,14 +125,19 @@ Specifies one or more paths to MAML help files. Wildcards are supported. ```yaml Type: System.String[] -Parameter Sets: Path -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True +DefaultValue: None +SupportsWildcards: true +Aliases: [] +ParameterSets: +- Name: Path + Position: 1 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -125,9 +149,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.String - -You can pipe path strings to this command. +### System.String[] ## OUTPUTS @@ -140,4 +162,4 @@ This cmdlet returns a `MamlCommandHelpInfo` objects. This is the same object tha ## RELATED LINKS -[Get-Help](xref:Microsoft.PowerShell.Core.Get-Help) +- [Get-Help](xref:Microsoft.PowerShell.Core.Get-Help) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Test-MarkdownCommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Test-MarkdownCommandHelp.md index abe4df9..cfd50eb 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Test-MarkdownCommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Test-MarkdownCommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/test-markdowncommandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/test-markdowncommandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Test-MarkdownCommandHelp --- @@ -29,6 +29,8 @@ Test-MarkdownCommandHelp [-Path] [-DetailView] [] Test-MarkdownCommandHelp -LiteralPath [-DetailView] [] ``` +## ALIASES + ## DESCRIPTION This command reads a Markdown help file and validates the structure of the help content by checking @@ -74,14 +76,19 @@ Instructs the command to output detailed validation information. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -LiteralPath @@ -96,15 +103,21 @@ For more information, see ```yaml Type: System.String[] -Parameter Sets: LiteralPath -Aliases: PSPath, LP -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False - +DefaultValue: None +SupportsWildcards: false +Aliases: +- PSPath +- LP +ParameterSets: +- Name: Literal + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: true + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -113,14 +126,19 @@ The path to the Markdown help file to test. ```yaml Type: System.String[] -Parameter Sets: Path -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True +DefaultValue: None +SupportsWildcards: true +Aliases: [] +ParameterSets: +- Name: Item + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: true + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -132,7 +150,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.String +### System.String[] ## OUTPUTS @@ -144,6 +162,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Export-MarkdownCommandHelp](Export-MarkdownCommandHelp.md) - -[New-MarkdownCommandHelp](New-MarkdownCommandHelp.md) +- [Export-MarkdownCommandHelp](Export-MarkdownCommandHelp.md) +- [New-MarkdownCommandHelp](New-MarkdownCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-CommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-CommandHelp.md index 94ed192..ccf04b4 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-CommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-CommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/update-commandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/update-commandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Update-CommandHelp --- @@ -30,6 +30,8 @@ Update-CommandHelp [-Path] [-WhatIf] [-Confirm] [] Update-CommandHelp -LiteralPath [-WhatIf] [-Confirm] [] ``` +## ALIASES + ## DESCRIPTION This cmdlet imports a **CommandHelp** object from a Markdown file and updates the object with the @@ -59,14 +61,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -LiteralPath @@ -81,14 +89,21 @@ For more information, see ```yaml Type: System.String[] -Parameter Sets: LiteralPath +DefaultValue: None +SupportsWildcards: false Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByVale) -Accept wildcard characters: False +- PSPath +- LP +ParameterSets: +- Name: LiteralPath + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -97,30 +112,41 @@ Specifies the path to one or more Markdown command file. Wildcard characters are ```yaml Type: System.String[] -Parameter Sets: Path -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True +DefaultValue: None +SupportsWildcards: true +Aliases: [] +ParameterSets: +- Name: Path + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet isn't run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -132,7 +158,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.String +### System.String[] ## OUTPUTS @@ -145,4 +171,4 @@ This command is similar to the `Update-MarkdownCommandHelp` cmdlet, but it updat ## RELATED LINKS -[Update-MarkdownCommandHelp](Update-MarkdownCommandHelp.md) +- [Update-MarkdownCommandHelp](Update-MarkdownCommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-MarkdownCommandHelp.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-MarkdownCommandHelp.md index d5f094e..67b937a 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-MarkdownCommandHelp.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-MarkdownCommandHelp.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/update-markdowncommandhelp?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/update-markdowncommandhelp?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Update-MarkdownCommandHelp --- @@ -31,6 +31,8 @@ Update-MarkdownCommandHelp -LiteralPath [-NoBackup] [-PassThru] [-Wha [] ``` +## ALIASES + ## DESCRIPTION This cmdlet imports a **CommandHelp** object from a Markdown file and updates the object with the @@ -55,14 +57,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -LiteralPath @@ -77,14 +85,21 @@ For more information, see ```yaml Type: System.String[] -Parameter Sets: LiteralPath +DefaultValue: None +SupportsWildcards: false Aliases: -Accepted values: -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +- PSPath +- LP +ParameterSets: +- Name: LiteralPath + Position: Named + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -NoBackup @@ -94,14 +109,19 @@ parameter to suppress the creation of the backup file. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -PassThru @@ -111,14 +131,19 @@ object. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -127,30 +152,41 @@ Specifies the path to one or more Markdown command file. Wildcard characters are ```yaml Type: System.String[] -Parameter Sets: Path -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True +DefaultValue: None +SupportsWildcards: true +Aliases: [] +ParameterSets: +- Name: Path + Position: 0 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet isn't run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -162,7 +198,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### System.String +### System.String[] ## OUTPUTS @@ -174,4 +210,4 @@ This command is similar to the `Update-CommandHelp` cmdlet, but it updates the s ## RELATED LINKS -[Update-CommandHelp](Update-CommandHelp.md) +- [Update-CommandHelp](Update-CommandHelp.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-MarkdownModuleFile.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-MarkdownModuleFile.md index b4ccc66..33de72c 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-MarkdownModuleFile.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Update-MarkdownModuleFile.md @@ -1,11 +1,11 @@ ---- +--- +document type: cmdlet external help file: Microsoft.PowerShell.PlatyPS.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/update-markdownmodulefile?view=ps-modules&WT.mc_id=ps-gethelp +HelpUri: https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/update-markdownmodulefile?view=ps-modules&WT.mc_id=ps-gethelp Locale: en-US Module Name: Microsoft.PowerShell.PlatyPS -ms.custom: preview1 -ms.date: 10/25/2024 -schema: 2.0.0 +ms.date: 07/17/2025 +PlatyPS schema version: 2024-05-01 title: Update-MarkdownModuleFile --- @@ -21,7 +21,7 @@ Updates the Markdown module file. ``` Update-MarkdownModuleFile [-Path] [-CommandHelp] [-Encoding ] - [-Force] [-HelpUri ] [-HelpInfoUri ] [-HelpVersion ] [-Locale ] + [-Force] [-HelpInfoUri ] [-HelpVersion ] [-Locale ] [-Metadata ] [-NoBackup] [-WhatIf] [-Confirm] [] ``` @@ -29,11 +29,12 @@ Update-MarkdownModuleFile [-Path] [-CommandHelp] [-Enco ``` Update-MarkdownModuleFile [-CommandHelp] -LiteralPath - [-Encoding ] [-Force] [-HelpUri ] [-HelpInfoUri ] - [-HelpVersion ] [-Locale ] [-Metadata ] [-NoBackup] [-WhatIf] - [-Confirm] [] + [-Encoding ] [-Force] [-HelpInfoUri ] [-HelpVersion ] + [-Locale ] [-Metadata ] [-NoBackup] [-WhatIf] [-Confirm] [] ``` +## ALIASES + ## DESCRIPTION This cmdlet updates a Markdown module file with **CommandHelp** object information imported from @@ -59,14 +60,19 @@ using this parameter. ```yaml Type: Microsoft.PowerShell.PlatyPS.Model.CommandHelp[] -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: 1 + IsRequired: true + ValueFromPipeline: true + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Confirm @@ -75,14 +81,20 @@ Prompts you for confirmation before running the cmdlet. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: +- cf +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Encoding @@ -92,14 +104,19 @@ the value of the `$OutputEncoding` preference variable. ```yaml Type: System.Text.Encoding -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Force @@ -108,14 +125,19 @@ Use the **Force** parameter to overwrite the output file if it already exists. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -HelpInfoUri @@ -125,30 +147,19 @@ the HelpInfoUri specified in the module manifest. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HelpUri - -{{ Fill HelpUri Description }} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -HelpVersion @@ -158,14 +169,19 @@ version is written to the `HelpInfo.xml` file that is used for updateable help. ```yaml Type: System.Version -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -LiteralPath @@ -180,14 +196,21 @@ For more information, see ```yaml Type: System.String -Parameter Sets: LiteralPath +DefaultValue: False +SupportsWildcards: false Aliases: -Accepted values: -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +- PSPath +- LP +ParameterSets: +- Name: literalpath + Position: Named + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Locale @@ -198,14 +221,19 @@ on your system. ```yaml Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Metadata @@ -218,14 +246,19 @@ the cmdlet ignores the values and outputs a warning. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -NoBackup @@ -235,14 +268,19 @@ parameter to suppress the creation of the backup file. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: False +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -Path @@ -251,30 +289,41 @@ Specifies a path to one or more module markdown files. ```yaml Type: System.String -Parameter Sets: Path -Aliases: -Accepted values: -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +DefaultValue: None +SupportsWildcards: false +Aliases: [] +ParameterSets: +- Name: path + Position: 0 + IsRequired: true + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet isn't run. +Runs the command in a mode that only reports what would happen without performing the actions. ```yaml Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) +DefaultValue: False +SupportsWildcards: false Aliases: -Accepted values: -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False +- wi +ParameterSets: +- Name: (All) + Position: Named + IsRequired: false + ValueFromPipeline: false + ValueFromPipelineByPropertyName: false + ValueFromRemainingArguments: false +DontShow: false +AcceptedValues: [] +HelpMessage: '' ``` ### CommonParameters @@ -286,7 +335,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.PowerShell.PlatyPS.Model.CommandHelp +### Microsoft.PowerShell.PlatyPS.Model.CommandHelp[] ## OUTPUTS @@ -296,4 +345,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[New-MarkdownModuleFile](New-MarkdownModuleFile.md) +- [New-MarkdownModuleFile](New-MarkdownModuleFile.md)