ConvertFrom-Markdown

  • Referencia
Modul:
Microsoft.PowerShell.Utility

Sztring vagy fájl tartalmának konvertálása MarkdownInfo-objektummá.

Syntax

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

Description

Ez a parancsmag a megadott tartalmat MarkdownInfo-vá alakítja. Ha meg van adva egy fájl elérési útja az Elérési út paraméterhez, a rendszer konvertálja a fájl tartalmát. A kimeneti objektum három tulajdonsággal rendelkezik:

  • A Jogkivonat tulajdonság a konvertált objektum absztrakt szintaxisfával (AST) rendelkezik
  • A Html tulajdonság a megadott bemenet HTML-konvertálásával rendelkezik
  • A VT100EncodedString tulajdonság anzisi (VT100) feloldósorozatokkal rendelkező konvertált sztringet tartalmaz, ha az AsVT100EncodedString paraméter meg lett adva

Ez a parancsmag a PowerShell 6.1-ben lett bevezetve.

Példák

1. példa: Markdown-tartalmat tartalmazó fájl konvertálása HTML-fájllá

ConvertFrom-Markdown -Path .\README.md

A MarkdownInfo objektum vissza lesz adva. A Tokens tulajdonság a fájl konvertált tartalmának AST-ével rendelkezik README.md . A Html tulajdonság a fájl HTML-konvertált README.md tartalmát tartalmazza.

2. példa: Markdown-tartalmat tartalmazó fájl átalakítása VT100 kódolású sztringgé

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

A MarkdownInfo objektum vissza lesz adva. A Tokens tulajdonság a fájl konvertált tartalmának AST-ével rendelkezik README.md . A VT100EncodedString tulajdonság a fájl VT100 kódolt sztringre konvertált tartalmát README.md tartalmazza.

3. példa: Markdown-tartalmat tartalmazó bemeneti objektum átalakítása VT100 kódolású sztringgé

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

A MarkdownInfo objektum vissza lesz adva. A fileInfo objektum VT100 Get-Item kódolású sztringgé lesz konvertálva. A Tokens tulajdonság a fájl konvertált tartalmának AST-ével rendelkezik README.md . A VT100EncodedString tulajdonság a fájl VT100 kódolt sztringre konvertált tartalmát README.md tartalmazza.

4. példa: Markdown-tartalmat tartalmazó sztring átalakítása VT100 kódolású sztringgé

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

A MarkdownInfo objektum vissza lesz adva. A megadott sztring **Bold text** VT100 kódolású sztringgé alakul, és elérhető a VT100EncodedString tulajdonságban.

Paraméterek

-AsVT100EncodedString

Megadja, hogy a kimenetet VT100-feloldókódokkal rendelkező sztringként kell-e kódolni.

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

-InputObject

A konvertálni kívánt objektumot adja meg. Ha egy System.String típusú objektum van megadva, a rendszer átalakítja a sztringet. System.IO.FileInfo típusú objektum megadásakor a rendszer konvertálja az objektum által megadott fájl tartalmát. Bármely más típusú objektum hibát eredményez.

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

-LiteralPath

Megadja a konvertálni kívánt fájl elérési útját.

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

-Path

Megadja a konvertálni kívánt fájl elérési útját.

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

Bevitelek

PSObject

Kimenetek

Microsoft.PowerShell.MarkdownRender.MarkdownInfo