Get-MarkdownMetadata

Referenz

Modul:: platyPS

Ruft Metadaten aus dem Header einer Markdowndatei ab.

Syntax

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

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

Beschreibung

Das Get-MarkdownMetadata Cmdlet ruft die Metadaten aus dem Header einer Markdowndatei ab, die von PlatyPS unterstützt wird. Der Befehl gibt die Metadaten als Hashtabelle zurück.

PlatyPS speichert Metadaten im Headerblock einer Markdowndatei als Schlüssel-Wert-Paare von Zeichenfolgen. Standardmäßig speichert PlatyPS den Namen der Hilfedatei und die Version des Markdownschemas.

Der Metadatenabschnitt kann vom Benutzer bereitgestellte Werte für die Verwendung mit externen Tools enthalten. Das Cmdlet New-ExternalHelp ignoriert diese Metadaten.

Beispiele

Beispiel 1: Abrufen von Metadaten aus einer Datei

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

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

Dieser Befehl ruft Metadaten aus einer Markdowndatei ab.

Beispiel 2: Abrufen von Metadaten aus einer Markdownzeichenfolge

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

Der erste Befehl ruft den Inhalt einer Datei ab und speichert sie in der $Markdown Variablen.

Der zweite Befehl ruft Metadaten aus der Zeichenfolge in $Metadata ab.

Beispiel 3: Abrufen von Metadaten aus allen Dateien in einem Ordner

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

Mit diesem Befehl werden Metadaten aus den einzelnen Markdowndateien im .\docs Ordner abgerufen.

Parameter

-Markdown

Gibt eine Zeichenfolge an, die Markdown-formatierten Text enthält.

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

-Path

Gibt ein Array von Pfaden von Markdowndateien oder -ordnern an.

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

Eingaben

String[]

Sie können ein Array von Pfaden an dieses Cmdlet übergeben.

Ausgaben

Dictionary[String, String]

Das Cmdlet gibt ein Dictionary[String, String] -Objekt zurück. Das Wörterbuch enthält Schlüssel-Wert-Paare, die im Markdownmetadatenblock gefunden werden.

Freigeben über