ConvertFrom-Markdown

  • Referensi
Modul:
Microsoft.PowerShell.Utility

Mengonversi konten string atau file menjadi objek MarkdownInfo .

Sintaks

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

Deskripsi

Cmdlet ini mengonversi konten yang ditentukan menjadi MarkdownInfo. Ketika jalur file ditentukan untuk parameter Jalur , konten pada file dikonversi. Objek output memiliki tiga properti:

  • Properti Token memiliki pohon sintaks abstrak (AST) dari objek yang dikonversi
  • Properti Html memiliki konversi HTML dari input yang ditentukan
  • Properti VT100EncodedString memiliki string yang dikonversi dengan urutan escape ANSI (VT100) jika parameter AsVT100EncodedString ditentukan

Cmdlet ini diperkenalkan di PowerShell 6.1.

Contoh

Contoh 1: Mengonversi file yang berisi konten Markdown ke HTML

ConvertFrom-Markdown -Path .\README.md

Objek MarkdownInfo dikembalikan. Properti Token memiliki AST dari konten file yang dikonversi README.md . Properti Html memiliki konten README.md file yang dikonversi HTML.

Contoh 2: Mengonversi file yang berisi konten Markdown ke string yang dikodekan VT100

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

Objek MarkdownInfo dikembalikan. Properti Token memiliki AST dari konten file yang dikonversi README.md . Properti VT100EncodedString memiliki konten README.md file yang dikonversi string yang dikodekan VT100.

Contoh 3: Mengonversi objek input yang berisi konten Markdown ke string yang dikodekan VT100

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

Objek MarkdownInfo dikembalikan. Objek FileInfo dari Get-Item dikonversi ke string yang dikodekan VT100. Properti Token memiliki AST dari konten file yang dikonversi README.md . Properti VT100EncodedString memiliki konten README.md file yang dikonversi string yang dikodekan VT100.

Contoh 4: Mengonversi string yang berisi konten Markdown ke string yang dikodekan VT100

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

Objek MarkdownInfo dikembalikan. String **Bold text** yang ditentukan dikonversi ke string yang dikodekan VT100 dan tersedia di properti VT100EncodedString .

Parameter

-AsVT100EncodedString

Menentukan apakah output harus dikodekan sebagai string dengan kode escape VT100.

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

-InputObject

Menentukan objek yang akan dikonversi. Ketika objek jenis System.String ditentukan, string dikonversi. Ketika objek jenis System.IO.FileInfo ditentukan, konten file yang ditentukan oleh objek dikonversi. Objek dari jenis lain mengakibatkan kesalahan.

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

-LiteralPath

Menentukan jalur ke file yang akan dikonversi.

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

-Path

Menentukan jalur ke file yang akan dikonversi.

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

Input

PSObject

Output

Microsoft.PowerShell.MarkdownRender.MarkdownInfo