Get-MarkdownMetadata

Riferimento

Modulo:: platyPS

Ottiene i metadati dall'intestazione di un file markdown.

Sintassi

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

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

Descrizione

Il Get-MarkdownMetadata cmdlet ottiene i metadati dall'intestazione di un file markdown supportato da PlatyPS. Il comando restituisce i metadati come tabella hash.

PlatyPS archivia i metadati nel blocco di intestazione di un file markdown come coppie chiave-valore di stringhe. Per impostazione predefinita, PlatyPS archivia il nome del file della Guida e la versione dello schema markdown.

La sezione Metadati può contenere valori forniti dall'utente per l'uso con strumenti esterni. Il cmdlet New-ExternalHelp ignora questi metadati.

Esempio

Esempio 1: Ottenere metadati da un file

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

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

Questo comando recupera i metadati da un file markdown.

Esempio 2: Ottenere metadati da una stringa 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

Il primo comando ottiene il contenuto di un file e li archivia nella $Markdown variabile.

Il secondo comando recupera i metadati dalla stringa in $Metadata.

Esempio 3: Ottenere metadati da tutti i file in una cartella

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

Questo comando ottiene i metadati da ognuno dei file markdown nella .\docs cartella.

Parametri

-Markdown

Specifica una stringa contenente testo formattato markdown.

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

-Path

Specifica una matrice di percorsi di file o cartelle markdown.

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

Input

String[]

È possibile inviare una matrice di percorsi a questo cmdlet.

Output

Dictionary[String, String]

Il cmdlet restituisce un Dictionary[String, String] oggetto. Il dizionario contiene coppie chiave-valore trovate nel blocco di metadati markdown.

Condividi tramite