Share via

ConvertFrom-Markdown

  • 參考
模組:
Microsoft.PowerShell.Utility

將字串或檔案的內容轉換為 MarkdownInfo 物件。

Syntax

ConvertFrom-Markdown
                [-Path] <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]
ConvertFrom-Markdown
                -LiteralPath <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]
ConvertFrom-Markdown
                -InputObject <PSObject>
                [-AsVT100EncodedString]
                [<CommonParameters>]

Description

此 Cmdlet 會將指定的內容轉換成 MarkdownInfo。 為 Path 參數指定檔案路徑時，會轉換檔案上的內容。 輸出物件有三個屬性：

  • Token 屬性具有已轉換物件的抽象語法樹狀結構 （AST）
  • Html 屬性具有指定輸入的 HTML 轉換
  • 如果指定 AsVT100EncodedString 參數，VT100EncodedString 屬性具有 ANSI （VT100） 逸出序列的已轉換字串

此 Cmdlet 已在 PowerShell 6.1 中引進。

範例

範例 1：將包含 Markdown 內容的檔案轉換成 HTML

ConvertFrom-Markdown -Path .\README.md

會傳回 MarkdownInfo 物件。 Tokens 屬性具有檔案已轉換內容的 README.md AST。 Html 屬性具有檔案的 README.md HTML 轉換內容。

範例 2：將包含 Markdown 內容的檔案轉換成 VT100 編碼的字串

ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString

會傳回 MarkdownInfo 物件。 Tokens 屬性具有檔案已轉換內容的 README.md AST。 VT100EncodedString 屬性具有已轉換檔案內容的 README.md VT100 編碼字串。

範例 3：將包含 Markdown 內容的輸入物件轉換成 VT100 編碼的字串

Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString

會傳回 MarkdownInfo 物件。 的 Get-Item FileInfo 物件會轉換成 VT100 編碼的字串。 Tokens 屬性具有檔案已轉換內容的 README.md AST。 VT100EncodedString 屬性具有已轉換檔案內容的 README.md VT100 編碼字串。

範例 4：將包含 Markdown 內容的字串轉換成 VT100 編碼的字串

"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString

會傳回 MarkdownInfo 物件。 指定的字串**Bold text**會轉換成 VT100 編碼的字串串，並可在 VT100EncodedString 屬性中使用。

參數

-AsVT100EncodedString

指定輸出是否應該編碼為具有 VT100 逸出碼的字串。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

指定要轉換的物件。 指定 System.String 類型的物件時，會轉換字串。 指定 System.IO.FileInfo 類型的物件時，會轉換物件所指定的檔案內容。 任何其他型別的物件都會導致錯誤。

Type:PSObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

指定要轉換之檔案的路徑。

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Path

指定要轉換之檔案的路徑。

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

輸入

PSObject

輸出

Microsoft.PowerShell.MarkdownRender.MarkdownInfo