通过

New-YamlHelp

模块:
platyPS Module

将 Markdown 帮助转换为 YAML，以便通过外部工具轻松阅读

语法

Default （默认值） 

New-YamlHelp
    [-Path] <String[]>
    -OutputFolder <String>
    [-Encoding <Encoding>]
    [-Force]
    [<CommonParameters>]

说明

New-YamlHelp cmdlet 的工作方式与 New-ExternalHelp cmdlet 类似，而不是创建 MAML 文件来支持 Get-Help，而是创建一组 YAML 文件，这些 YAML 文件可由外部工具读取，以提供帮助页面的自定义呈现。

示例

示例 1：创建 YAML 文件

PS C:\> New-YamlHelp -Path .\docs -OutputFolder .\out\yaml

    Directory: D:\Working\PlatyPS\out\yaml


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        6/15/2017  11:13 AM           2337 Get-HelpPreview.yml
-a----        6/15/2017  11:13 AM           3502 Get-MarkdownMetadata.yml
-a----        6/15/2017  11:13 AM           4143 New-ExternalHelp.yml
-a----        6/15/2017  11:13 AM           3082 New-ExternalHelpCab.yml
-a----        6/15/2017  11:13 AM           2581 New-MarkdownAboutHelp.yml
-a----        6/15/2017  11:13 AM          12356 New-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           1681 New-YamlHelp.yml
-a----        6/15/2017  11:13 AM           5053 Update-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           4661 Update-MarkdownHelpModule.yml
-a----        6/15/2017  11:13 AM           3350 Update-MarkdownHelpSchema.yml

这会为每个 cmdlet 创建一个 YAML 文件，以便外部工具可以读取每个 cmdlet 的结构化数据。

示例 2：创建具有特定编码的 YAML 文件

PS C:\> New-YamlHelp -Path .\docs -OutputFolder .\out\yaml -Force -Encoding ([System.Text.Encoding]::Unicode)

    Directory: D:\Working\PlatyPS\out\yaml


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        6/15/2017  11:13 AM           2337 Get-HelpPreview.yml
-a----        6/15/2017  11:13 AM           3502 Get-MarkdownMetadata.yml
-a----        6/15/2017  11:13 AM           4143 New-ExternalHelp.yml
-a----        6/15/2017  11:13 AM           3082 New-ExternalHelpCab.yml
-a----        6/15/2017  11:13 AM           2581 New-MarkdownAboutHelp.yml
-a----        6/15/2017  11:13 AM          12356 New-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           1681 New-YamlHelp.yml
-a----        6/15/2017  11:13 AM           5053 Update-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           4661 Update-MarkdownHelpModule.yml
-a----        6/15/2017  11:13 AM           3350 Update-MarkdownHelpSchema.yml

这将读取和写入指定的 -Encoding 中的文件。 Force 参数将覆盖已经存在的文件。

参数

-Encoding

指定外部帮助文件的字符编码。 指定 System.Text.Encoding 对象。 有关详细信息，请参阅 about_Character_Encoding。

参数属性

类型:Encoding
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Force

指示此 cmdlet 覆盖具有相同名称的现有文件。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-OutputFolder

指定要在其中创建 YAML 文件的文件夹

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Path

指定 markdown 文件或文件夹的路径数组。 此 cmdlet 基于这些文件和文件夹创建外部帮助。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:True
来自管道的值（按属性名称）:True
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

String

可以通过管道将路径数组传递给此 cmdlet。

输出

FileInfo

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