1
- ---
1
+ ---
2
+ document type : cmdlet
2
3
external help file : Microsoft.PowerShell.PlatyPS.dll-Help.xml
3
- online version : https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-mamlcommandhelp?view=ps-modules&WT.mc_id=ps-gethelp
4
+ HelpUri : https://learn.microsoft.com/powershell/module/microsoft.powershell.platyps/export-mamlcommandhelp?view=ps-modules&WT.mc_id=ps-gethelp
4
5
Locale : en-US
5
6
Module Name : Microsoft.PowerShell.PlatyPS
6
- ms.custom : preview1
7
- ms.date : 10/25/2024
8
- schema : 2.0.0
7
+ ms.date : 07/17/2025
8
+ PlatyPS schema version : 2024-05-01
9
9
title : Export-MamlCommandHelp
10
10
---
11
11
@@ -24,6 +24,8 @@ Export-MamlCommandHelp [-CommandHelp] <CommandHelp[]> [-OutputFolder] <string>
24
24
[-Encoding <Encoding>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
25
25
```
26
26
27
+ ## ALIASES
28
+
27
29
## DESCRIPTION
28
30
29
31
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.
56
58
57
59
``` yaml
58
60
Type : Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
59
- Parameter Sets : (All)
60
- Aliases :
61
- Accepted values :
62
- Required : True
63
- Position : 0
64
- Default value : None
65
- Accept pipeline input : True (ByValue)
66
- Accept wildcard characters : False
61
+ DefaultValue : None
62
+ SupportsWildcards : false
63
+ Aliases : []
64
+ ParameterSets :
65
+ - Name : (All)
66
+ Position : 0
67
+ IsRequired : true
68
+ ValueFromPipeline : true
69
+ ValueFromPipelineByPropertyName : false
70
+ ValueFromRemainingArguments : false
71
+ DontShow : false
72
+ AcceptedValues : []
73
+ HelpMessage : ' '
67
74
` ` `
68
75
69
76
### -Confirm
@@ -72,14 +79,20 @@ Prompts you for confirmation before running the cmdlet.
72
79
73
80
` ` ` yaml
74
81
Type : System.Management.Automation.SwitchParameter
75
- Parameter Sets : (All)
76
- Aliases : cf
77
- Accepted values :
78
- Required : False
79
- Position : Named
80
- Default value : False
81
- Accept pipeline input : False
82
- Accept wildcard characters : False
82
+ DefaultValue : False
83
+ SupportsWildcards : false
84
+ Aliases :
85
+ - cf
86
+ ParameterSets :
87
+ - Name : (All)
88
+ Position : Named
89
+ IsRequired : false
90
+ ValueFromPipeline : false
91
+ ValueFromPipelineByPropertyName : false
92
+ ValueFromRemainingArguments : false
93
+ DontShow : false
94
+ AcceptedValues : []
95
+ HelpMessage : ' '
83
96
` ` `
84
97
85
98
### -Encoding
@@ -89,14 +102,19 @@ the value of the `$OutputEncoding` preference variable.
89
102
90
103
` ` ` yaml
91
104
Type: System.Text.Encoding
92
- Parameter Sets: (All)
93
- Aliases:
94
- Accepted values:
95
- Required: False
96
- Position: Named
97
- Default value: False
98
- Accept pipeline input: False
99
- Accept wildcard characters: False
105
+ DefaultValue: False
106
+ SupportsWildcards: false
107
+ Aliases: []
108
+ ParameterSets:
109
+ - Name: (All)
110
+ Position: Named
111
+ IsRequired: false
112
+ ValueFromPipeline: false
113
+ ValueFromPipelineByPropertyName: false
114
+ ValueFromRemainingArguments: false
115
+ DontShow: false
116
+ AcceptedValues: []
117
+ HelpMessage: ''
100
118
` ` `
101
119
102
120
# ## -Force
@@ -105,14 +123,19 @@ Use the **Force** parameter to overwrite the output file if it already exists.
105
123
106
124
` ` ` yaml
107
125
Type: System.Management.Automation.SwitchParameter
108
- Parameter Sets: (All)
109
- Aliases:
110
- Accepted values:
111
- Required: False
112
- Position: Named
113
- Default value: False
114
- Accept pipeline input: False
115
- Accept wildcard characters: False
126
+ DefaultValue: False
127
+ SupportsWildcards: false
128
+ Aliases: []
129
+ ParameterSets:
130
+ - Name: (All)
131
+ Position: Named
132
+ IsRequired: false
133
+ ValueFromPipeline: false
134
+ ValueFromPipelineByPropertyName: false
135
+ ValueFromRemainingArguments: false
136
+ DontShow: false
137
+ AcceptedValues: []
138
+ HelpMessage: ''
116
139
` ` `
117
140
118
141
# ## -OutputFolder
@@ -121,30 +144,41 @@ The folder where the markdown file is saved. If the folder doesn't exist, it's c
121
144
122
145
` ` ` yaml
123
146
Type: System.String
124
- Parameter Sets: (All)
125
- Aliases:
126
- Accepted values:
127
- Required: True
128
- Position: 1
129
- Default value: None
130
- Accept pipeline input: False
131
- Accept wildcard characters: False
147
+ DefaultValue: None
148
+ SupportsWildcards: false
149
+ Aliases: []
150
+ ParameterSets:
151
+ - Name: (All)
152
+ Position: 1
153
+ IsRequired: true
154
+ ValueFromPipeline: false
155
+ ValueFromPipelineByPropertyName: false
156
+ ValueFromRemainingArguments: false
157
+ DontShow: false
158
+ AcceptedValues: []
159
+ HelpMessage: ''
132
160
` ` `
133
161
134
162
# ## -WhatIf
135
163
136
- Shows what would happen if the cmdlet runs. The cmdlet isn't run .
164
+ Runs the command in a mode that only reports what would happen without performing the actions .
137
165
138
166
` ` ` yaml
139
167
Type: System.Management.Automation.SwitchParameter
140
- Parameter Sets: (All)
141
- Aliases: wi
142
- Accepted values:
143
- Required: False
144
- Position: Named
145
- Default value: False
146
- Accept pipeline input: False
147
- Accept wildcard characters: False
168
+ DefaultValue: False
169
+ SupportsWildcards: false
170
+ Aliases:
171
+ - wi
172
+ ParameterSets:
173
+ - Name: (All)
174
+ Position: Named
175
+ IsRequired: false
176
+ ValueFromPipeline: false
177
+ ValueFromPipelineByPropertyName: false
178
+ ValueFromRemainingArguments: false
179
+ DontShow: false
180
+ AcceptedValues: []
181
+ HelpMessage: ''
148
182
` ` `
149
183
150
184
# ## CommonParameters
@@ -156,7 +190,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
156
190
157
191
# # INPUTS
158
192
159
- # ## Microsoft.PowerShell.PlatyPS.Model.CommandHelp
193
+ # ## Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
160
194
161
195
# # OUTPUTS
162
196
@@ -166,4 +200,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
166
200
167
201
# # RELATED LINKS
168
202
169
- [Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md)
203
+ - [Import-MarkdownCommandHelp](Import-MarkdownCommandHelp.md)
0 commit comments