通过

New-MarkdownAboutHelp

  • 参考
模块:
platyPS

从模板生成新的“关于主题 MD”文件。

语法

New-MarkdownAboutHelp
   [-OutputFolder] <String>
   [[-AboutName] <String>]
   [<CommonParameters>]

说明

New-MarkdownAboutHelp cmdlet 生成使用 About Topic 的标准元素预填充的 Markdown 文件。 该 cmdlet 将复制模板 MD、根据 AboutName 参数重命名标头和文件名，并将文件存储在 OutputFolder 参数指定的目录中。

“关于主题”可以转换为 Txt 格式。 关于主题必须采用 txt 格式，否则 PowerShell 帮助引擎将无法分析文档。 使用 New-ExternalHelp cmdlet 将 About Topic markdown 文件转换为 About Topic txt 文件。

示例

示例 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

创建并显示 PowerShell 关于主题 Markdown 文件的文件信息。

示例 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

从现有的 Markdown About 文件创建 PowerShell About Topic Txt 文件。

参数

-AboutName

关于主题的名称。

类型:String
Position:1
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-OutputFolder

要在其中创建有关主题的目录。

类型:String
Position:0
默认值:None
必需:True
接受管道输入:False
接受通配符:False

输入

None

输出

Object

此 cmdlet 返回已创建文件的对象。

备注

需要将有关主题添加到 cab 文件，以利用可更新的帮助。