Show-Markdown
VT100 エスケープ シーケンスを使用してわかりやすい方法で、または HTML を使用してブラウザーで Markdown ファイルまたは文字列をコンソールに表示します。
構文
Path (既定)
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
説明
Show-Markdown コマンドレットは、ターミナルまたはブラウザーで、人間が判読できる形式で Markdown をレンダリングするために使用されます。
Show-Markdown は、ターミナルがレンダリングする VT100 エスケープ シーケンスを含む文字列を返すことができます (VT100 エスケープ シーケンスをサポートしている場合)。 これは主に、ターミナルで Markdown ファイルを表示するために使用されます。
ConvertFrom-Markdown パラメーターを指定することで、 を使用してこの文字列を取得することもできます。
Show-Markdown には、ブラウザーを開き、Markdown のレンダリングされたバージョンを表示する機能もあります。 マークダウンを HTML に変換し、既定のブラウザーで HTML ファイルを開くことで、マークダウンがレンダリングされます。
Show-Markdown
Set-MarkdownOption 使用して、ターミナルで 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 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
InputObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LiteralPath
Markdown ファイルへのパスを指定します。 Path パラメーターとは異なり、LiteralPath の値は型指定されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 単一引用符は、エスケープ シーケンスとして文字を解釈しないように PowerShell に指示します。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
パラメーター セット
LiteralPath
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Path
レンダリングする Markdown ファイルへのパスを指定します。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
Path
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-UseBrowser
Markdown 入力を HTML としてコンパイルし、既定のブラウザーで開きます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
