ConvertFrom-Markdown
Konvertera innehållet i en sträng eller en fil till ett MarkdownInfo- objekt.
Syntax
PathParamSet (Standard)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
Description
Den här cmdleten konverterar det angivna innehållet till en MarkdownInfo. När en filsökväg har angetts för parametern Path konverteras innehållet i filen. Utdataobjektet har tre egenskaper:
- Egenskapen Token har det konverterade objektets abstrakta syntaxträd (AST)
- Egenskapen Html har HTML-konvertering av angivna indata
- Egenskapen VT100EncodedString har den konverterade strängen med ANSI-undantagssekvenser (VT100) om parametern AsVT100EncodedString har angetts
Den här cmdleten introducerades i PowerShell 6.1.
Exempel
Exempel 1: Konvertera en fil som innehåller Markdown-innehåll till HTML
ConvertFrom-Markdown -Path .\README.md
Objektet MarkdownInfo returneras. Egenskapen Tokens har AST för det konverterade innehållet i README.md-filen. Egenskapen Html har HTML-konverterat innehåll i README.md-filen.
Exempel 2: Konvertera en fil som innehåller Markdown-innehåll till en VT100-kodad sträng
ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString
Objektet MarkdownInfo returneras. Egenskapen Tokens har AST för det konverterade innehållet i README.md-filen. Egenskapen VT100EncodedString har VT100-kodad sträng konverterat innehåll i README.md-filen.
Exempel 3: Konvertera indataobjekt som innehåller Markdown-innehåll till en VT100-kodad sträng
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString
Objektet MarkdownInfo returneras. Objektet FileInfo från Get-Item konverteras till en VT100-kodad sträng. Egenskapen Tokens har AST för det konverterade innehållet i README.md-filen. Egenskapen VT100EncodedString har VT100-kodad sträng konverterat innehåll i README.md-filen.
Exempel 4: Konvertera en sträng som innehåller Markdown-innehåll till en VT100-kodad sträng
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
Objektet MarkdownInfo returneras. Den angivna strängen **Bold text** konverteras till en VT100-kodad sträng och är tillgänglig i egenskapen VT100EncodedString.
Parametrar
-AsVT100EncodedString
Anger om utdata ska kodas som en sträng med VT100-undantagskoder.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-InputObject
Anger det objekt som ska konverteras. När ett objekt av typen System.String anges konverteras strängen. När ett objekt av typen System.IO.FileInfo anges konverteras innehållet i filen som anges av objektet. Objekt av någon annan typ resulterar i ett fel.
Parameteregenskaper
| Typ: | PSObject |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
InputObjParamSet
| Position: | Named |
| Obligatorisk: | True |
| Värde från pipeline: | True |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-LiteralPath
Anger en sökväg till filen som ska konverteras.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | PSPath, SP |
Parameteruppsättningar
LiteralParamSet
| Position: | Named |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Path
Anger en sökväg till filen som ska konverteras.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokertecken: | True |
| DontShow: | False |
Parameteruppsättningar
PathParamSet
| Position: | 0 |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.
