Get-MarkdownMetadata

Moduł:

platyPS

Pobiera metadane z nagłówka pliku markdown.

Składnia

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

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

Opis

Polecenie Get-MarkdownMetadata cmdlet pobiera metadane z nagłówka pliku markdown obsługiwanego przez platformę PlatyPS. Polecenie zwraca metadane jako tabelę skrótów.

Platforma PlatyPS przechowuje metadane w bloku nagłówka pliku markdown jako pary klucz-wartość ciągów. Domyślnie platforma PlatyPS przechowuje nazwę pliku pomocy i wersję schematu markdown.

Sekcja metadanych może zawierać wartości udostępniane przez użytkownika do użycia z narzędziami zewnętrznymi. Polecenie cmdlet New-ExternalHelp ignoruje te metadane.

Przykłady

Przykład 1. Pobieranie metadanych z pliku

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

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

To polecenie pobiera metadane z pliku markdown.

Przykład 2. Pobieranie metadanych z ciągu 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

Pierwsze polecenie pobiera zawartość pliku i zapisuje je w zmiennej $Markdown .

Drugie polecenie pobiera metadane z ciągu w $Metadata.

Przykład 3. Pobieranie metadanych ze wszystkich plików w folderze

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

To polecenie pobiera metadane z każdego z plików markdown w folderze .\docs .

Parametry

-Markdown

Określa ciąg zawierający sformatowany tekst markdown.

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

-Path

Określa tablicę ścieżek plików lub folderów markdown.

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

Dane wejściowe

String[]

Możesz przekazać tablicę ścieżek do tego polecenia cmdlet.

Dane wyjściowe

Dictionary[String, String]

Polecenie cmdlet zwraca Dictionary[String, String] obiekt. Słownik zawiera pary klucz-wartość znalezione w bloku metadanych języka Markdown.