Get-MarkdownMetadata

參考

模組:: platyPS

從 Markdown 檔案的標頭取得中繼資料。

Syntax

Get-MarkdownMetadata
   -Path <String[]>
   [<CommonParameters>]

Get-MarkdownMetadata
   -Markdown <String>
   [<CommonParameters>]

Description

Cmdlet Get-MarkdownMetadata 會從 PlatyPS 支援的 Markdown 檔案標頭取得中繼資料。此命令會以雜湊表的形式傳回中繼資料。

PlatyPS 會將中繼資料儲存在 Markdown 檔案的標頭區塊中，做為字串的機碼/值組。 PlatyPS 預設會儲存說明檔名和 Markdown 架構版本。

中繼資料區段可以包含使用者提供的值，以搭配外部工具使用。 New-ExternalHelp Cmdlet 會忽略此中繼資料。

範例

範例 1：從檔案取得中繼資料

PS C:\> Get-MarkdownMetadata -Path ".\docs\Get-MarkdownMetadata.md"

Key                Value
---                -----
external help file platyPS-help.xml
schema             2.0.0

此命令會從 Markdown 檔案擷取中繼資料。

範例 2：從 Markdown 字串取得中繼資料

PS C:\> $Markdown = Get-Content -Path ".\docs\Get-MarkdownMetadata.md" -Raw
PS C:\> Get-MarkdownMetadata -Markdown $Markdown

Key                Value
---                -----
external help file platyPS-help.xml
schema             2.0.0

第一個命令會取得檔案的內容，並將其儲存在變數中 $Markdown 。

第二個命令會從 $Metadata 中的字串擷取中繼資料。

範例 3：從資料夾中的所有檔案取得中繼資料

PS C:\> Get-MarkdownMetadata -Path ".\docs"

Key                Value
---                -----
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0

此命令會從資料夾中的每個 Markdown 檔案 .\docs 取得中繼資料。

參數

-Markdown

指定包含 Markdown 格式化文字的字串。

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

-Path

指定 Markdown 檔案或資料夾的路徑陣列。

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

輸入

String[]

您可以使用管線將路徑陣列傳送至此 Cmdlet。

輸出

Dictionary[String, String]

Cmdlet 會傳 Dictionary[String, String] 回物件。字典包含 Markdown 中繼資料區塊中找到的索引鍵/值組。

共用方式為