ConvertFrom-Markdown
Konversikan konten string atau file ke objek MarkdownInfo.
Sintaks
PathParamSet (Default)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
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 konten yang dikonversi dari file README.md. Properti Html memiliki konten html yang dikonversi dari file README.md.
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 konten yang dikonversi dari file README.md. Properti VT100EncodedString memiliki konten yang dikonversi string yang dikodekan VT100 dari file README.md.
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 konten yang dikonversi dari file README.md. Properti VT100EncodedString memiliki konten yang dikonversi string yang dikodekan VT100 dari file README.md.
Contoh 4: Mengonversi string yang berisi konten Markdown ke string yang dikodekan VT100
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
Objek MarkdownInfo dikembalikan. String yang ditentukan **Bold text** dikonversi ke string yang dikodekan VT100 dan tersedia di properti VT100EncodedString.
Parameter
-AsVT100EncodedString
Menentukan apakah output harus dikodekan sebagai string dengan kode escape VT100.
Properti parameter
| Jenis: | SwitchParameter |
| Nilai default: | None |
| 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 |
-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.
Properti parameter
| Jenis: | PSObject |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
Set parameter
InputObjParamSet
| 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 yang akan dikonversi.
Properti parameter
| Jenis: | String[] |
| Nilai default: | None |
| Mendukung wildcard: | False |
| DontShow: | False |
| Alias: | PSPath, LP |
Set parameter
LiteralParamSet
| Position: | Named |
| Wajib: | True |
| Nilai dari alur: | False |
| Nilai dari alur berdasarkan nama properti: | False |
| Nilai dari argumen yang tersisa: | False |
-Path
Menentukan jalur ke file yang akan dikonversi.
Properti parameter
| Jenis: | String[] |
| Nilai default: | None |
| Mendukung wildcard: | True |
| DontShow: | False |
Set parameter
PathParamSet
| Position: | 0 |
| Wajib: | True |
| 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.
