ConvertFrom-Markdown

  • Başvuru
Modül:
Microsoft.PowerShell.Utility

Bir dizenin veya dosyanın içeriğini MarkdownInfo nesnesine dönüştürün.

Syntax

ConvertFrom-Markdown
                [-Path] <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]
ConvertFrom-Markdown
                -LiteralPath <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]
ConvertFrom-Markdown
                -InputObject <PSObject>
                [-AsVT100EncodedString]
                [<CommonParameters>]

Description

Bu cmdlet, belirtilen içeriği MarkdownInfo'ya dönüştürür. Path parametresi için bir dosya yolu belirtildiğinde, dosyadaki içerik dönüştürülür. Çıkış nesnesinin üç özelliği vardır:

  • Token özelliği, dönüştürülen nesnenin soyut söz dizimi ağacına (AST) sahiptir
  • Html özelliği, belirtilen girişin HTML dönüştürmesine sahiptir
  • AsVT100EncodedString parametresi belirtilmişse VT100EncodedString özelliği ANSI (VT100) kaçış dizileriyle dönüştürülmüş dizeye sahiptir

Bu cmdlet PowerShell 6.1'de kullanıma sunulmuştur.

Örnekler

Örnek 1: Markdown içeriği içeren bir dosyayı HTML'ye dönüştürme

ConvertFrom-Markdown -Path .\README.md

MarkdownInfo nesnesi döndürülür. Tokens özelliği, dosyanın dönüştürülmüş içeriğinin AST'sine README.md sahiptir. Html özelliği, dosyanın HTML dönüştürülmüş içeriğine README.md sahiptir.

Örnek 2: Markdown içeriği içeren bir dosyayı VT100 ile kodlanmış bir dizeye dönüştürme

ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString

MarkdownInfo nesnesi döndürülür. Tokens özelliği, dosyanın dönüştürülmüş içeriğinin AST'sine README.md sahiptir. VT100EncodedString özelliği, dosyanın VT100 kodlamalı dize dönüştürülmüş içeriğine README.md sahiptir.

Örnek 3: Markdown içeriği içeren giriş nesnesini VT100 ile kodlanmış bir dizeye dönüştürme

Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString

MarkdownInfo nesnesi döndürülür. dosyasından FileInfo nesnesi Get-Item VT100 kodlanmış bir dizeye dönüştürülür. Tokens özelliği, dosyanın dönüştürülmüş içeriğinin AST'sine README.md sahiptir. VT100EncodedString özelliği, dosyanın VT100 kodlamalı dize dönüştürülmüş içeriğine README.md sahiptir.

Örnek 4: Markdown içeriği içeren bir dizeyi VT100 ile kodlanmış bir dizeye dönüştürme

"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString

MarkdownInfo nesnesi döndürülür. Belirtilen dize **Bold text** VT100 ile kodlanmış bir dizeye dönüştürülür ve VT100EncodedString özelliğinde kullanılabilir.

Parametreler

-AsVT100EncodedString

Çıktının VT100 kaçış kodlarıyla bir dize olarak kodlanması gerekip gerekmediğini belirtir.

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

-InputObject

Dönüştürülecek nesneyi belirtir. System.String türünde bir nesne belirtildiğinde, dize dönüştürülür. System.IO.FileInfo türünde bir nesne belirtildiğinde, nesne tarafından belirtilen dosyanın içeriği dönüştürülür. Başka bir türdeki nesneler hatayla sonuçlanır.

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

-LiteralPath

Dönüştürülecek dosyanın yolunu belirtir.

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Path

Dönüştürülecek dosyanın yolunu belirtir.

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

Girişler

PSObject

Çıkışlar

Microsoft.PowerShell.MarkdownRender.MarkdownInfo