ConvertFrom-Markdown
Sztring vagy fájl tartalmának konvertálása MarkdownInfo objektummá.
Syntax
PathParamSet (Alapértelmezett)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
Description
Ez a parancsmag átalakítja a megadott tartalmat egy MarkdownInfo. Ha a Elérési út paraméterhez fájlelérési utat ad meg, a fájl tartalma konvertálódik. A kimeneti objektum három tulajdonsággal rendelkezik:
- A Token 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 a 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 lesz visszaadva. A Tokens tulajdonság a README.md fájl konvertált tartalmának AST-ével rendelkezik. A Html tulajdonság a README.md fájl HTML-konvertált 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 lesz visszaadva. A Tokens tulajdonság a README.md fájl konvertált tartalmának AST-ével rendelkezik. A VT100EncodedString tulajdonság a README.md fájl VT100 kódolt sztringre konvertált tartalmát 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 lesz visszaadva. A FileInfo objektumot a Get-Item VT100 kódolású sztringgé alakítja. A Tokens tulajdonság a README.md fájl konvertált tartalmának AST-ével rendelkezik. A VT100EncodedString tulajdonság a README.md fájl VT100 kódolt sztringre konvertált tartalmát tartalmazza.
4. példa: Markdown-tartalmat tartalmazó sztring átalakítása VT100 kódolású sztringgé
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
A MarkdownInfo objektum lesz visszaadva. A megadott sztring **Bold text** VT100 kódolású sztringgé alakul, és VT100EncodedString tulajdonságban érhető el.
Paraméterek
-AsVT100EncodedString
Megadja, hogy a kimenetet VT100-feloldókódokkal rendelkező sztringként kell-e kódolni.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-InputObject
A konvertálni kívánt objektumot adja meg. Ha egy System.String típusú objektum van megadva, a rendszer konvertálja a sztringet. Ha egy System.IO.FileInfo típusú objektum van megadva, a rendszer konvertálja az objektum által megadott fájl tartalmát. Bármely más típusú objektum hibát eredményez.
Paramétertulajdonságok
| Típus: | PSObject |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
InputObjParamSet
| Position: | Named |
| Kötelező: | True |
| Folyamatból származó érték: | True |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-LiteralPath
Megadja a konvertálni kívánt fájl elérési útját.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
| Aliasok: | PSPath, LP |
Paraméterkészletek
LiteralParamSet
| Position: | Named |
| Kötelező: | True |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Path
Megadja a konvertálni kívánt fájl elérési útját.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
PathParamSet
| Position: | 0 |
| Kötelező: | True |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
CommonParameters
Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.
