New-MarkdownAboutHelp
Generates a new About Topic MD file from template.
语法
Default (默认值)
New-MarkdownAboutHelp
[-OutputFolder] <String>
[[-AboutName] <String>]
[<CommonParameters>]
说明
The New-MarkdownAboutHelp
cmdlet generates a Markdown file that is prepopulated with the standard elements of an About Topic.
The cmdlet copies the template MD, renames headers and file name according to the AboutName parameter,
and deposits the file in the directory designated by the OutputFolder parameter.
The About Topic can be converted to Txt format. About topics must be in txt format or the PowerShell Help engine will not be able to parse the document. Use the New-ExternalHelp cmdlet to convert About Topic markdown files into About Topic txt files.
示例
Example 1
PS C:\> New-MarkdownAboutHelp -OutputFolder C:\Test -AboutName TestAboutTopic
PS C:\> Get-ChildItem C:\Test
Directory: C:\Test
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 7/13/2016 2:12 PM 1491 about_TestAboutTopic.md
Create and display file info for PowerShell About Topic Markdown File.
Example 2
PS C:\> New-ExternalHelp -Path C:\Test\ -OutputPath C:\Test
Directory: C:\Test
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 7/13/2016 2:15 PM 1550 about_TestAboutTopic.help.txt
Create PowerShell About Topic Txt file from existing Markdown About file.
参数
-AboutName
The name of the about topic.
参数属性
类型: | String |
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | 1 |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-OutputFolder
The directory to create the about topic in.
参数属性
类型: | String |
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | 0 |
必需: | True |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
输入
None
输出
Object
This cmdlet returns a object for created files.
备注
The about topics will need to be added to a cab file to leverage updatable help.