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 parameter Path , 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 html-eigenschap 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 door VT100 gecodeerde tekenreeks geconverteerde inhoud van het README.md bestand.

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 FileInfo-object wordt Get-Item geconverteerd naar een VT100-gecodeerde tekenreeks. De eigenschap Tokens heeft de AST van de geconverteerde inhoud van het README.md bestand. De eigenschap VT100EncodedString heeft de door VT100 gecodeerde tekenreeks geconverteerde inhoud van het README.md bestand.

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

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

Het MarkdownInfo-object wordt geretourneerd. De opgegeven tekenreeks wordt geconverteerd naar een tekenreeks **Bold text** 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 dat moet worden geconverteerd. Wanneer een object van het type System.String is opgegeven, wordt de tekenreeks geconverteerd. Wanneer een object van het type System.IO.FileInfo is opgegeven, wordt de inhoud van het bestand dat is opgegeven door het object 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 dat moet worden geconverteerd.

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 dat moet worden geconverteerd.

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

Invoerwaarden

PSObject

Uitvoerwaarden

Microsoft.PowerShell.MarkdownRender.MarkdownInfo