ConvertFrom-Markdown

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

文字列またはファイルの内容を MarkdownInfo オブジェクトに変換します。

構文

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

説明

このコマンドレットは、指定されたコンテンツを MarkdownInfo に変換します。 Path パラメーターにファイル パスを指定すると、ファイルの内容が変換されます。 出力オブジェクトには、次の 3 つのプロパティがあります。

  • Token プロパティには、変換されたオブジェクトの抽象構文ツリー (AST) があります
  • Html プロパティには、指定された入力の HTML 変換があります
  • ASVT100EncodedString パラメーターが指定されている場合、VT100EncodedString プロパティには ANSI (VT100) エスケープ シーケンスを含む変換された文字列があります

このコマンドレットは、PowerShell 6.1 で導入されました。

例

例 1: Markdown コンテンツを含むファイルを HTML に変換する

ConvertFrom-Markdown -Path .\README.md

MarkdownInfo オブジェクトが返されます。 Tokens プロパティには、ファイルの変換されたコンテンツの AST がありますREADME.md。 Html プロパティには、ファイルの HTML 変換されたコンテンツがありますREADME.md。

例 2: Markdown コンテンツを含むファイルを VT100 エンコード文字列に変換する

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

MarkdownInfo オブジェクトが返されます。 Tokens プロパティには、ファイルの変換されたコンテンツの AST がありますREADME.md。 VT100EncodedString プロパティには、VT100 エンコード文字列で変換されたファイルの内容がありますREADME.md。

例 3: Markdown コンテンツを含む入力オブジェクトを VT100 エンコード文字列に変換する

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

MarkdownInfo オブジェクトが返されます。 FileInfo オブジェクトは Get-Item VT100 でエンコードされた文字列に変換されます。 Tokens プロパティには、ファイルの変換されたコンテンツの AST がありますREADME.md。 VT100EncodedString プロパティには、VT100 エンコード文字列で変換されたファイルの内容がありますREADME.md。

例 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