ConvertFrom-Markdown
文字列またはファイルの内容を MarkdownInfo オブジェクトに変換します。
構文
PathParamSet (既定)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
説明
このコマンドレットは、指定したコンテンツを MarkdownInfoに変換します。 Path パラメーターにファイル パスを指定すると、ファイルの内容が変換されます。 出力オブジェクトには、次の 3 つのプロパティがあります。
- Token プロパティには、変換されたオブジェクトの抽象構文ツリー (AST) があります
- Html プロパティには、指定された入力の HTML 変換があります
- VT100EncodedString プロパティには、AsVT100EncodedString パラメーターが指定されている場合、ANSI (VT100) エスケープ シーケンスを含む変換された文字列があります
このコマンドレットは、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 オブジェクトは、VT100 でエンコードされた文字列に変換されます。
Tokens プロパティには、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 |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-InputObject
変換するオブジェクトを指定します。 System.String 型のオブジェクトを指定すると、文字列が変換されます。 System.IO.FileInfo 型のオブジェクトを指定すると、そのオブジェクトで指定されたファイルの内容が変換されます。 その他の型のオブジェクトはエラーになります。
パラメーターのプロパティ
| 型: | PSObject |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
InputObjParamSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LiteralPath
変換するファイルへのパスを指定します。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
パラメーター セット
LiteralParamSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Path
変換するファイルへのパスを指定します。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
PathParamSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
