ConvertFrom-Markdown
將字串或檔案的內容轉換為 MarkdownInfo 物件。
語法
PathParamSet (預設值)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
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 物件。 來自 README.md 檔案轉換後內容的 AST。
VT100EncodedString 屬性具有 README.md 檔案的 VT100 編碼字串轉換內容。
範例 4：將包含 Markdown 內容的字串轉換成 VT100 編碼的字串
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
會傳回 MarkdownInfo 物件。 指定的字串 **Bold text** 會轉換成 VT100 編碼的字串，而且可在 VT100EncodedString 屬性中使用。
參數
-AsVT100EncodedString
指定輸出是否應該編碼為具有 VT100 逸出碼的字串。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-InputObject
指定要轉換的物件。 指定 System.String 類型的物件時，會轉換字串。 當指定 system.IO.FileInfo 類型的物件 時，就會轉換物件所指定的檔案內容。 任何其他型別的物件都會導致錯誤。
參數屬性
| 類型: | PSObject |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
InputObjParamSet
| Position: | Named |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-LiteralPath
指定要轉換之檔案的路徑。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | PSPath, LP |
參數集
LiteralParamSet
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Path
指定要轉換之檔案的路徑。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | True |
| 不要顯示: | False |
參數集
PathParamSet
| Position: | 0 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。
