Delen via

ConvertFrom-Markdown

  • Referentie
Module:
Microsoft.PowerShell.Utility

Converteer de inhoud van een tekenreeks of een bestand naar een MarkdownInfo-object .

Syntax

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

Description

Met deze cmdlet wordt de opgegeven inhoud geconverteerd naar een MarkdownInfo. Wanneer een bestandspad is opgegeven voor de path-parameter , wordt de inhoud van het bestand geconverteerd. Het uitvoerobject heeft drie eigenschappen:

  • De eigenschap Token heeft de abstracte syntaxisstructuur (AST) van het geconverteerde object
  • De eigenschap Html heeft de HTML-conversie van de opgegeven invoer
  • De eigenschap VT100EncodedString heeft de geconverteerde tekenreeks met ANSI-escapereeksen (VT100) als de parameter AsVT100EncodedString is opgegeven

Deze cmdlet is geïntroduceerd in PowerShell 6.1.

Voorbeelden

Voorbeeld 1: een bestand met Markdown-inhoud converteren naar HTML

ConvertFrom-Markdown -Path .\README.md

Het MarkdownInfo-object wordt geretourneerd. De eigenschap Tokens heeft de AST van de geconverteerde inhoud van het README.md bestand. De html-eigenschap bevat de html-geconverteerde inhoud van het README.md bestand.

Voorbeeld 2: een bestand met Markdown-inhoud converteren naar een VT100-gecodeerde tekenreeks

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

Het MarkdownInfo-object wordt geretourneerd. De eigenschap Tokens heeft de AST van de geconverteerde inhoud van het README.md bestand. De eigenschap VT100EncodedString heeft de inhoud van het README.md bestand met de VT100-gecodeerde tekenreeks geconverteerd.

Voorbeeld 3: invoerobject met Markdown-inhoud converteren naar een VT100-gecodeerde tekenreeks

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

Het MarkdownInfo-object wordt geretourneerd. Het object FileInfo van Get-Item wordt geconverteerd naar een tekenreeks met VT100-codering. De eigenschap Tokens heeft de AST van de geconverteerde inhoud van het README.md bestand. De eigenschap VT100EncodedString heeft de inhoud van het README.md bestand met de VT100-gecodeerde tekenreeks geconverteerd.

Voorbeeld 4: een tekenreeks met Markdown-inhoud converteren naar een tekenreeks met VT100-codering

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

Het MarkdownInfo-object wordt geretourneerd. De opgegeven tekenreeks **Bold text** wordt geconverteerd naar een tekenreeks met VT100-codering en beschikbaar in de eigenschap VT100EncodedString .

Parameters

-AsVT100EncodedString

Hiermee geeft u op of de uitvoer moet worden gecodeerd als een tekenreeks met VT100-escapecodes.

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

-InputObject

Hiermee geeft u het object te converteren. Wanneer een object van het type System.String wordt opgegeven, wordt de tekenreeks geconverteerd. Wanneer een object van het type System.IO.FileInfo wordt opgegeven, wordt de inhoud van het bestand dat door het object is opgegeven geconverteerd. Objecten van een ander type resulteren in een fout.

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

-LiteralPath

Hiermee geeft u een pad naar het bestand te converteren.

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

-Path

Hiermee geeft u een pad naar het bestand te converteren.

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

Invoerwaarden

PSObject

Uitvoerwaarden

Microsoft.PowerShell.MarkdownRender.MarkdownInfo