Merge-MarkdownHelp

參考

模組:: platyPS

將相同 Cmdlet 的多個 Markdown 版本合併成單一 Markdown 檔案。

Syntax

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

Description

類似模組或相同模組的不同版本通常包含重複的內容。

Merge-MarkdownHelp 將多個 Markdown 檔案合併成單一 Markdown 檔案。它會使用 applicable: yaml 元資料欄位來識別適用的版本或標籤。它會在兩個層級上運作：針對整個 Cmdlet 和個別參數。

產生的 Markdown 包含標記 applicable: 以及原始 Markdown 檔案的所有內容。重複的內容只會被忽略。每個檔案唯一的內容會使用 合併標記進行合併，後面接著適用標籤的逗號分隔清單。 合併標記是文字字串，可做為標記來描述已合併的內容。預設 合併標記 文字包含三個驚嘆號!! 不過，這可以使用 -MergeMarker 旗標 變更為任何相關的文字。

範例

範例 1

Test-CsPhoneBootstrap.md Cmdlet 同時包含在 Lync Server 2010 和 Lync Server 2013 中。大部分的內容都會重複，因此我們想要讓 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。

Type:	Encoding
Position:	Named
Default value:	UTF8 without BOM
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExplicitApplicableIfAll

一律寫出適用標籤的完整清單。根據預設，存在於所有變化中的 Cmdlet 和參數不會取得應用程式標籤。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

指出此 Cmdlet 會覆寫具有相同名稱的現有檔案。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MergeMarker

要當做合併文字指標使用的字串。標記之後會包含適用的標籤清單

Type:	String
Position:	3
Default value:	'!!! '
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OutputPath

指定此 Cmdlet 建立合併 Markdown 說明檔的資料夾路徑。

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

指定 Markdown 檔案或資料夾的路徑陣列。此 Cmdlet 會根據這些檔案和資料夾建立合併的 Markdown 說明。

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

輸入

String[]

輸出

FileInfo[]

共用方式為