Show-Markdown

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

VT100 エスケープ シーケンスを使用してわかりやすい方法で、または HTML を使用してブラウザーで Markdown ファイルまたは文字列をコンソールに表示します。

構文

Show-Markdown
    [-Path] <String[]>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -InputObject <PSObject>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -LiteralPath <String[]>
    [-UseBrowser]
    [<CommonParameters>]

説明

Show-Markdown コマンドレットは、ターミナルまたはブラウザーで、人間が判読できる形式で Markdown をレンダリングするために使用されます。

Show-Markdown は、ターミナルがレンダリングする VT100 エスケープ シーケンスを含む文字列を返すことができます (VT100 エスケープ シーケンスがサポートされている場合)。 これは主に、ターミナルで Markdown ファイルを表示するために使用されます。 この文字列は、AsVT100EncodedString パラメーターを指定してConvertFrom-Markdownを使用して取得することもできます。

Show-Markdown には、ブラウザーを開き、Markdown のレンダリングされたバージョンを表示する機能もあります。 マークダウンを HTML に変換し、既定のブラウザーで HTML ファイルを開くことで、マークダウンがレンダリングされます。

Set-MarkdownOptionを使用Show-Markdownターミナルで Markdown をレンダリングする方法を変更できます。

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

例

例 1: パスを指定する簡単な例

Show-Markdown -Path ./README.md

例 2: 文字列を指定する簡単な例

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

例 2: ブラウザーで Markdown を開く

Show-Markdown -Path ./README.md -UseBrowser

パラメーター

-InputObject

ターミナルに表示される Markdown 文字列。 サポートされている形式で渡さない場合、 Show-Markdown はエラーを出力します。

型:PSObject
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-LiteralPath

Markdown ファイルへのパスを指定します。 Path パラメーターとは異なり、LiteralPath の値は型指定されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 単一引用符は、エスケープ シーケンスとして文字を解釈しないように PowerShell に指示します。

型:String[]
Aliases:PSPath, LP
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Path

レンダリングする Markdown ファイルへのパスを指定します。

型:String[]
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:True

-UseBrowser

Markdown 入力を HTML としてコンパイルし、既定のブラウザーで開きます。

型:SwitchParameter
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

PSObject

String[]

出力

String