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轉換
- VT100EncodedString 屬性若指定 AsVT100EncodedString 參數，則可轉換為 ANSI （VT100） 跳脫序列的字串
此 cmdlet 於 PowerShell 6.1 中引入。
範例
範例 1：將包含 Markdown 內容的檔案轉換成 HTML
ConvertFrom-Markdown -Path .\README.md
MarkdownInfo 物件會被回傳。
Tokens 屬性包含檔案轉換後內容README.md的 AST。
Html 屬性包含檔案的 HTML 轉換內容README.md。
範例 2：將包含 Markdown 內容的檔案轉換成 VT100 編碼的字串
ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString
MarkdownInfo 物件會被回傳。
Tokens 屬性包含檔案轉換後內容README.md的 AST。
VT100EncodedString 屬性將 VT100 編碼的字串內容轉換成檔案內容README.md。
範例 3：將包含 Markdown 內容的輸入物件轉換成 VT100 編碼的字串
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString
MarkdownInfo 物件會被回傳。 FileInfo 物件會被轉換成 VT100 編碼的字串。Get-Item
Tokens 屬性包含檔案轉換後內容README.md的 AST。
VT100EncodedString 屬性將 VT100 編碼的字串內容轉換成檔案內容README.md。
範例 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。
