Get-MarkdownMetadata

Modul:

platyPS

Získá metadata z hlavičky souboru markdown.

Syntax

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

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

Description

Rutina Get-MarkdownMetadata získá metadata z hlavičky souboru markdownu, který podporuje PlatyPS. Příkaz vrátí metadata jako tabulku hash.

PlatyPS ukládá metadata v bloku hlaviček souboru markdownu jako páry klíč-hodnota řetězců. PlatyPS ve výchozím nastavení ukládá název souboru nápovědy a verzi schématu Markdownu.

Oddíl Metadata může obsahovat uživatelem zadané hodnoty pro použití s externími nástroji. Rutina New-ExternalHelp tato metadata ignoruje.

Příklady

Příklad 1: Získání metadat ze souboru

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

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

Tento příkaz načte metadata ze souboru markdownu.

Příklad 2: Získání metadat z řetězce markdownu

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

První příkaz získá obsah souboru a uloží ho do $Markdown proměnné.

Druhý příkaz načte metadata z řetězce v $Metadata.

Příklad 3: Získání metadat ze všech souborů ve složce

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

Tento příkaz získá metadata z každého souboru Markdownu .\docs ve složce.

Parametry

-Markdown

Určuje řetězec, který obsahuje text ve formátu markdownu.

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

-Path

Určuje pole cest k souborům nebo složkám markdownu.

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

Vstupy

String[]

K této rutině můžete připojit pole cest.

Výstupy

Dictionary[String, String]

Rutina vrátí Dictionary[String, String] objekt. Slovník obsahuje páry klíč-hodnota nalezené v bloku metadat markdownu.