ConvertFrom-Markdown

  • Referens
Modul:
Microsoft.PowerShell.Utility

Konvertera innehållet i en sträng eller en fil till ett MarkdownInfo-objekt .

Syntax

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

Description

Den här cmdleten konverterar det angivna innehållet till en MarkdownInfo. När en filsökväg har angetts för parametern Path konverteras innehållet i filen. Utdataobjektet har tre egenskaper:

  • Egenskapen Token har det konverterade objektets abstrakta syntaxträd (AST)
  • Html-egenskapen har HTML-konverteringen av angivna indata
  • Egenskapen VT100EncodedString har den konverterade strängen med ANSI(VT100) escape-sekvenser om parametern AsVT100EncodedString angavs

Den här cmdleten introducerades i PowerShell 6.1.

Exempel

Exempel 1: Konvertera en fil som innehåller Markdown-innehåll till HTML

ConvertFrom-Markdown -Path .\README.md

MarkdownInfo-objektet returneras. Egenskapen Tokens har AST för det konverterade innehållet i README.md filen. Html-egenskapen har HTML-konverterat innehåll i README.md filen.

Exempel 2: Konvertera en fil som innehåller Markdown-innehåll till en VT100-kodad sträng

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

MarkdownInfo-objektet returneras. Egenskapen Tokens har AST för det konverterade innehållet i README.md filen. Egenskapen VT100EncodedString har det VT100-kodade strängkonverterade innehållet i README.md filen.

Exempel 3: Konvertera indataobjekt som innehåller Markdown-innehåll till en VT100-kodad sträng

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

MarkdownInfo-objektet returneras. FileInfo-objektet från Get-Item konverteras till en VT100-kodad sträng. Egenskapen Tokens har AST för det konverterade innehållet i README.md filen. Egenskapen VT100EncodedString har det VT100-kodade strängkonverterade innehållet i README.md filen.

Exempel 4: Konvertera en sträng som innehåller Markdown-innehåll till en VT100-kodad sträng

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

MarkdownInfo-objektet returneras. Den angivna strängen **Bold text** konverteras till en VT100-kodad sträng och är tillgänglig i egenskapen VT100EncodedString .

Parametrar

-AsVT100EncodedString

Anger om utdata ska kodas som en sträng med VT100-undantagskoder.

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

-InputObject

Anger det objekt som ska konverteras. När ett objekt av typen System.String har angetts konverteras strängen. När ett objekt av typen System.IO.FileInfo anges konverteras innehållet i filen som anges av objektet. Objekt av någon annan typ resulterar i ett fel.

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

-LiteralPath

Anger en sökväg till filen som ska konverteras.

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

-Path

Anger en sökväg till filen som ska konverteras.

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

Indata

PSObject

Utdata

Microsoft.PowerShell.MarkdownRender.MarkdownInfo