Merge-MarkdownHelp

参考

模块:: platyPS

将同一 cmdlet 的多个 markdown 版本合并到单个 markdown 文件中。

语法

Merge-MarkdownHelp
     [-Path] <String[]>
     [-OutputPath] <String>
     [-Encoding <Encoding>]
     [-ExplicitApplicableIfAll]
     [-Force]
     [[-MergeMarker] <String>]
     [<CommonParameters>]

说明

类似模块或相同模块的不同版本通常包含重复的内容。

Merge-MarkdownHelp 将多个 markdown 文件合并到单个 markdown 文件中。它使用 applicable: yaml 元数据字段来标识适用的版本或标记。它针对两个级别：整个 cmdlet 和单个参数。

生成的 markdown 包含 applicable: 标记以及原始 markdown 文件的所有内容。重复的内容只是被忽略。每个文件唯一的内容使用 合并标记合并，后跟以逗号分隔的适用标记列表。 合并标记 是一个文本字符串，充当标记来描述合并的内容。默认 合并标记 文本由三个感叹号组成!! 但是，可以使用 -MergeMarker 标志将其更改为任何相关文本。

示例

示例 1

Lync Server 2010 和 Lync Server 2013 中都包括 Test-CsPhoneBootstrap.md cmdlet。大部分内容都是重复的，因此我们希望为 cmdlet 创建一个文件，其中包含从每个单个文件合并的唯一内容。

Merge-MarkdownHelp -Path @('Lync Server 2010\Test-CsPhoneBootstrap.md', 'Lync Server 2013\Test-CsPhoneBootstrap.md') -OutputPath lync

生成的文件将位于 lync\Test-CsPhoneBootstrap.md。

参数

-Encoding

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

类型:	Encoding
Position:	Named
默认值:	UTF8 without BOM
必需:	False
接受管道输入:	False
接受通配符:	False

-ExplicitApplicableIfAll

始终写出适用标记的完整列表。默认情况下，所有变体中存在的 cmdlet 和参数不会获取应用程序标记。

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

-Force

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

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

-MergeMarker

要用作合并文本指示器的字符串。标记后将包含适用的标记列表

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

-OutputPath

指定此 cmdlet 在其中创建组合 markdown 帮助文件的文件夹的路径。

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

-Path

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

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

输入

String[]

输出

FileInfo[]

通过