Get-MarkdownMetadata

構文

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

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

説明

コマンドレットは Get-MarkdownMetadata 、PlatyPS でサポートされているマークダウン ファイルのヘッダーからメタデータを取得します。 このコマンドは、メタデータをハッシュ テーブルとして返します。

PlatyPS は、マークダウン ファイルのヘッダー ブロックに、文字列のキーと値のペアとしてメタデータを格納します。 既定では、PlatyPS にはヘルプ ファイル名とマークダウン スキーマ バージョンが格納されます。

メタデータ セクションには、外部ツールで使用するユーザー指定の値を含めることができます。 New-ExternalHelp コマンドレットは、このメタデータを無視します。

例

例 1: ファイルからメタデータを取得する

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

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

このコマンドは、マークダウン ファイルからメタデータを取得します。

例 2: マークダウン文字列からメタデータを取得する

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 格納します。

2 番目のコマンドは、$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

このコマンドは、 フォルダー内の各マークダウン ファイルからメタデータを .\docs 取得します。

パラメーター

-Markdown

-Path

入力

String[]

パスの配列をこのコマンドレットにパイプできます。

出力

Dictionary[String, String]

コマンドレットは オブジェクトを Dictionary[String, String] 返します。 ディクショナリには、markdown メタデータ ブロック内にあるキーと値のペアが含まれています。