Show-Markdown
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
して、ターミナルでの Markdown のレンダリング方法Show-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
エラーが生成されます。
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
Markdown ファイルへのパスを指定します。 Path パラメーターとは異なり、LiteralPath の値は型指定されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 単一引用符は、エスケープ シーケンスとして文字を解釈しないように PowerShell に指示します。
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
レンダリングする Markdown ファイルへのパスを指定します。
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-UseBrowser
Markdown 入力を HTML としてコンパイルし、既定のブラウザーで開きます。
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
String[]
出力
関連リンク
PowerShell
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示