Get-MarkdownMetadata

Modül:
platyPS Module

Markdown dosyasının üst bilgisinden meta verileri alır.

Syntax

FromPath (Varsayılan) 

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

FromMarkdownString 

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

Description

Get-MarkdownMetadata cmdlet'i meta verileri PlatyPS tarafından desteklenen bir markdown dosyasının üst bilgisinden alır. komutu meta verileri karma tablo olarak döndürür.

PlatyPS, meta verileri bir markdown dosyasının üst bilgi bloğunda dizelerin anahtar-değer çiftleri olarak depolar. PlatyPS varsayılan olarak yardım dosyası adını ve markdown şema sürümünü depolar.

Meta veriler bölümü, dış araçlarla kullanmak için kullanıcı tarafından sağlanan değerler içerebilir. New-ExternalHelp cmdlet'i bu meta verileri yoksayar.

Örnekler

Örnek 1: Dosyadan meta verileri alma

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

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

Bu komut, markdown dosyasından meta verileri alır.

Örnek 2: Markdown dizesinden meta verileri alma

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

İlk komut bir dosyanın içeriğini alır ve bunları $Markdown değişkeninde depolar.

İkinci komut, $Metadata dizesinden meta verileri alır.

Örnek 3: Klasördeki tüm dosyalardan meta verileri alma

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

Bu komut, .\docs klasöründeki markdown dosyalarının her birinden meta verileri alır.

Parametreler

-Markdown

Markdown biçimli metin içeren bir dize belirtir.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

FromMarkdownString
Position:Named
Zorunlu:True
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-Path

Markdown dosya veya klasörlerinin yol dizisini belirtir.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:True
DontShow:False

Parametre kümeleri

FromPath
Position:Named
Zorunlu:True
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:True
Kalan bağımsız değişkenlerden elde edilen değer:False

CommonParameters

Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.

Girişler

String

Bir yol dizisini bu cmdlet'e yöneltebilirsiniz.

Çıkışlar

Dictionary

Cmdlet bir Dictionary[String, String] nesnesi döndürür. Sözlük, markdown meta veri bloğunda bulunan anahtar-değer çiftlerini içerir.