Show-Markdown

  • Referensi
Modul:
Microsoft.PowerShell.Utility

Menampilkan file atau string Markdown di konsol dengan cara yang ramah menggunakan urutan escape VT100 atau di browser menggunakan HTML.

Sintaks

Show-Markdown
    [-Path] <String[]>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -InputObject <PSObject>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -LiteralPath <String[]>
    [-UseBrowser]
    [<CommonParameters>]

Deskripsi

Show-Markdown Cmdlet digunakan untuk merender Markdown dalam format yang dapat dibaca manusia baik di terminal atau di browser.

Show-Markdown dapat mengembalikan string yang menyertakan urutan escape VT100 yang dirender terminal (jika mendukung urutan escape VT100). Ini terutama digunakan untuk melihat file Markdown di terminal. Anda juga bisa mendapatkan string ini melalui ConvertFrom-Markdown dengan menentukan parameter AsVT100EncodedString .

Show-Markdown juga memiliki kemampuan untuk membuka browser dan menunjukkan versi Markdown yang dirender. Ini merender Markdown dengan mengubahnya menjadi HTML dan membuka file HTML di browser default Anda.

Anda dapat mengubah cara Show-Markdown merender Markdown di terminal dengan menggunakan Set-MarkdownOption.

Cmdlet ini diperkenalkan di PowerShell 6.1.

Contoh

Contoh 1: Contoh sederhana yang menentukan jalur

Show-Markdown -Path ./README.md

Contoh 2: Contoh sederhana yang menentukan string

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

Contoh 2: Membuka Markdown di browser

Show-Markdown -Path ./README.md -UseBrowser

Parameter

-InputObject

String Markdown yang akan ditampilkan di terminal. Jika Anda tidak lulus dalam format yang didukung, Show-Markdown akan memancarkan kesalahan.

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

-LiteralPath

Menentukan jalur ke file Markdown. Tidak seperti parameter Jalur, nilai LiteralPath digunakan persis seperti yang ditik. Tidak ada karakter yang ditafsirkan sebagai kartubebas. Jika jalur menyertakan karakter escape, sertakan dalam tanda kutip tunggal. Tanda kutip tunggal memberi tahu PowerShell untuk tidak menginterpretasikan karakter apa pun sebagai urutan escape.

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

-Path

Menentukan jalur ke file Markdown yang akan dirender.

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

-UseBrowser

Mengkompilasi input Markdown sebagai HTML dan membukanya di browser default Anda.

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

Input

PSObject

String[]

Output

String