Show-Markdown
Menampilkan file atau string Markdown di konsol dengan cara yang ramah menggunakan urutan escape VT100 atau di browser menggunakan HTML.
Sintaks
Path (Default)
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Deskripsi
Cmdlet Show-Markdown 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 meneruskan format yang didukung, Show-Markdown akan mengeluarkan kesalahan.
Properti parameter
| Jenis: | PSObject |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
InputObject
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | True |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-LiteralPath
Menentukan jalur ke file Markdown. Tidak seperti parameter Jalur, nilai LiteralPath digunakan persis seperti yang ditik. Tidak ada karakter yang ditafsirkan sebagai wildcard. Jika jalur menyertakan karakter escape, bungkus jalur tersebut dalam tanda kutip tunggal. Tanda kutip tunggal memberi tahu PowerShell untuk tidak menginterpretasikan karakter apa pun sebagai urutan escape.
Properti parameter
| Jenis: | String[] |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | PSPath, LP |
Set parameter
LiteralPath
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-Path
Menentukan jalur ke file Markdown yang akan dirender.
Properti parameter
| Jenis: | String[] |
| Nilai default: | None |
| Mendukung wildcard: | True |
| DontShow: | False |
Set parameter
Path
| Position: | 0 |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | True |
| Nilai dari argumen yang tersisa: | False |
-UseBrowser
Mengkompilasi input Markdown sebagai HTML dan membukanya di browser default Anda.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | False |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
(All)
| Position: | Named |
| Wajib: | False |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
CommonParameters
Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.
