| external help file | Locale | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Microsoft.PowerShell.Commands.Utility.dll-Help.xml |
en-US |
Microsoft.PowerShell.Utility |
11/02/2018 |
2.0.0 |
ConvertFrom-Markdown |
Convert the contents of a string or a file to a MarkdownInfo object.
ConvertFrom-Markdown [-Path] <String[]> [-AsVT100EncodedString] [<CommonParameters>]
ConvertFrom-Markdown -LiteralPath <String[]> [-AsVT100EncodedString] [<CommonParameters>]
ConvertFrom-Markdown -InputObject <PSObject> [-AsVT100EncodedString] [<CommonParameters>]
This cmdlet converts the specified content into a MarkdownInfo. When a file path is specified for the Path parameter, the contents on the file are converted. The output object has three properties:
- The Token property has the abstract syntax tree (AST) of the converted object
- The Html property has the HTML conversion of the specified input
- The VT100EncodedString property has the converted string with ANSI (VT100) escape sequences if the AsVT100EncodedString parameter was specified
This cmdlet was introduced in PowerShell 6.1.
ConvertFrom-Markdown -Path .\README.mdThe MarkdownInfo object is returned. The Tokens property has the AST of the converted
content of the README.md file. The Html property has the HTML converted content of the
README.md file.
ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedStringThe MarkdownInfo object is returned. The Tokens property has the AST of the converted
content of the README.md file. The VT100EncodedString property has the VT100-encoded string
converted content of the README.md file.
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedStringThe MarkdownInfo object is returned. The FileInfo object from Get-Item is converted to a
VT100-encoded string. The Tokens property has the AST of the converted content of the
README.md file. The VT100EncodedString property has the VT100-encoded string converted content
of the README.md file.
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedStringThe MarkdownInfo object is returned. The specified string **Bold text** is converted to a
VT100-encoded string and available in VT100EncodedString property.
Specifies if the output should be encoded as a string with VT100 escape codes.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the object to be converted. When an object of type System.String is specified, the string is converted. When an object of type System.IO.FileInfo is specified, the contents of the file specified by the object are converted. Objects of any other type result in an error.
Type: System.Management.Automation.PSObject
Parameter Sets: InputObjParamSet
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies a path to the file to be converted.
Type: System.String[]
Parameter Sets: LiteralParamSet
Aliases: PSPath, LP
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies a path to the file to be converted.
Type: System.String[]
Parameter Sets: PathParamSet
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: TrueThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.