ConvertFrom-Markdown
Converteer de inhoud van een tekenreeks of een bestand naar een MarkdownInfo object.
Syntaxis
PathParamSet (Standaard)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
Description
Met deze cmdlet wordt de opgegeven inhoud geconverteerd naar een MarkdownInfo-. Wanneer een bestandspad wordt opgegeven voor de parameter Pad, wordt de inhoud van het bestand geconverteerd. Het uitvoerobject heeft drie eigenschappen:
- De eigenschap token heeft de abstracte syntaxisstructuur (AST) van het geconverteerde object
- De eigenschap Html- heeft de HTML-conversie van de opgegeven invoer
- De eigenschap VT100EncodedString heeft de geconverteerde tekenreeks met ANSI-escapereeksen (VT100) als de parameter AsVT100EncodedString parameter is opgegeven
Deze cmdlet is geïntroduceerd in PowerShell 6.1.
Voorbeelden
Voorbeeld 1: Een bestand met Markdown-inhoud converteren naar HTML
ConvertFrom-Markdown -Path .\README.md
Het MarkdownInfo object wordt geretourneerd. De eigenschap Tokens heeft de AST van de geconverteerde inhoud van het README.md-bestand. De eigenschap Html- heeft de HTML-geconverteerde inhoud van het README.md-bestand.
Voorbeeld 2: Een bestand met Markdown-inhoud converteren naar een VT100-gecodeerde tekenreeks
ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString
Het MarkdownInfo object wordt geretourneerd. De eigenschap Tokens heeft de AST van de geconverteerde inhoud van het README.md-bestand. De eigenschap VT100EncodedString bevat de door VT100 gecodeerde tekenreeks geconverteerde inhoud van het README.md-bestand.
Voorbeeld 3: Invoerobject met Markdown-inhoud converteren naar een VT100-gecodeerde tekenreeks
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString
Het MarkdownInfo object wordt geretourneerd. Het FileInfo--object van Get-Item wordt geconverteerd naar een VT100-gecodeerde tekenreeks. De eigenschap Tokens heeft de AST van de geconverteerde inhoud van het README.md-bestand. De eigenschap VT100EncodedString bevat de door VT100 gecodeerde tekenreeks geconverteerde inhoud van het README.md-bestand.
Voorbeeld 4: Een tekenreeks met Markdown-inhoud converteren naar een VT100-gecodeerde tekenreeks
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
Het MarkdownInfo object wordt geretourneerd. De opgegeven tekenreeks **Bold text** wordt geconverteerd naar een met VT100 gecodeerde tekenreeks en beschikbaar in eigenschap VT100EncodedString.
Parameters
-AsVT100EncodedString
Hiermee geeft u op of de uitvoer moet worden gecodeerd als een tekenreeks met VT100-escapecodes.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-InputObject
Hiermee geeft u het object dat moet worden geconverteerd. Wanneer een object van het type System.String is opgegeven, wordt de tekenreeks geconverteerd. Wanneer een object van het type System.IO.FileInfo is opgegeven, wordt de inhoud van het bestand dat is opgegeven door het object geconverteerd. Objecten van een ander type resulteren in een fout.
Parametereigenschappen
| Type: | PSObject |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
InputObjParamSet
| Position: | Named |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-LiteralPath
Hiermee geeft u een pad naar het bestand dat moet worden geconverteerd.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | PSPath, LP |
Parametersets
LiteralParamSet
| Position: | Named |
| Verplicht: | True |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Path
Hiermee geeft u een pad naar het bestand dat moet worden geconverteerd.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | True |
| DontShow: | False |
Parametersets
PathParamSet
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.
