Get-MarkdownMetadata

Referentie

Module:: platyPS

Hiermee haalt u metagegevens op uit de koptekst van een Markdown-bestand.

Syntaxis

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

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

Description

De Get-MarkdownMetadata cmdlet haalt de metagegevens op uit de header van een Markdown-bestand dat wordt ondersteund door PlatyPS. De opdracht retourneert de metagegevens als een hash-tabel.

PlatyPS slaat metagegevens op in het headerblok van een Markdown-bestand als sleutel-waardeparen van tekenreeksen. PlatyPS slaat standaard help-bestandsnaam en markdown-schemaversie op.

De sectie Metagegevens kan door de gebruiker geleverde waarden bevatten voor gebruik met externe hulpprogramma's. De cmdlet New-ExternalHelp negeert deze metagegevens.

Voorbeelden

Voorbeeld 1: Metagegevens ophalen uit een bestand

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

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

Met deze opdracht worden metagegevens opgehaald uit een Markdown-bestand.

Voorbeeld 2: Metagegevens ophalen uit een Markdown-tekenreeks

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

Met de eerste opdracht wordt de inhoud van een bestand opgeslagen en opgeslagen in de variabele $Markdown.

Met de tweede opdracht worden metagegevens opgehaald uit de tekenreeks in $Metadata.

Voorbeeld 3: Metagegevens ophalen uit alle bestanden in een map

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

Met deze opdracht worden metagegevens opgehaald uit elk van de Markdown-bestanden in de map .\docs.

Parameters

-Markdown

Hiermee geeft u een tekenreeks op die opgemaakte markdown-tekst bevat.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Path

Hiermee geeft u een matrix van paden van Markdown-bestanden of -mappen.

Type:	String[]
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	True

Invoerwaarden

String[]

U kunt een matrix met paden naar deze cmdlet doorsluisen.

Uitvoerwaarden

Dictionary[String, String]

De cmdlet retourneert een Dictionary[String, String]-object. De woordenlijst bevat sleutel-waardeparen in het markdown-metagegevensblok.

Delen via