Set-MarkdownOption

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

コンソールで Markdown コンテンツをレンダリングするために使用する色とスタイルを設定します。

構文

Set-MarkdownOption
   [-Header1Color <String>]
   [-Header2Color <String>]
   [-Header3Color <String>]
   [-Header4Color <String>]
   [-Header5Color <String>]
   [-Header6Color <String>]
   [-Code <String>]
   [-ImageAltTextForegroundColor <String>]
   [-LinkForegroundColor <String>]
   [-ItalicsForegroundColor <String>]
   [-BoldForegroundColor <String>]
   [-PassThru]
   [<CommonParameters>]
Set-MarkdownOption
   [-PassThru]
   -Theme <String>
   [<CommonParameters>]
Set-MarkdownOption
   [-PassThru]
   [-InputObject] <PSObject>
   [<CommonParameters>]

説明

コンソールで Markdown コンテンツをレンダリングするために使用する色とスタイルを設定します。 これらのスタイルは、レンダリングされる Markdown テキストの色とスタイルを変更する ANSI エスケープ コードを使用して定義されます。

Markdown の詳細については、CommonMark の Web サイトを参照してください。

Note

設定で使用される文字列値は、ANSI エスケープ シーケンスの エスケープ 文字 ([char]0x1B) に続く文字です。 文字列にエスケープ文字を含めないでください。 ANSI エスケープ コードの動作の詳細については、ANSI_escape_codeを参照してください。

例

例 1 - ライト テーマに切り替える

次の使用例は、Light テーマを選択し、PassThru パラメーターを使用して新しい構成を表示します。

Set-MarkdownOption -Theme Light -PassThru

Header1         : [7m
Header2         : [4;33m
Header3         : [4;34m
Header4         : [4;35m
Header5         : [4;36m
Header6         : [4;30m
Code            : [48;2;155;155;155;38;2;30;30;30m
Link            : [4;38;5;117m
Image           : [33m
EmphasisBold    : [1m
EmphasisItalics : [36m

例 2 - 色とスタイルの設定をカスタマイズする

次の使用例は、Markdown ヘッダーのエスケープ コードを変更します。 ヘッダーの既定の構成では、さまざまな色の下線付きテキストとしてレンダリングされます。 この変更により、下線のスタイルが削除されます。

$mdOptions = Get-MarkdownOption
$mdOptions.Header2 = '[93m'
$mdOptions.Header3 = '[94m'
$mdOptions.Header4 = '[95m'
$mdOptions.Header5 = '[96m'
$mdOptions.Header6 = '[97m'
Set-MarkdownOption -InputObject $mdOptions -PassThru

Header1         : [7m
Header2         : [93m
Header3         : [94m
Header4         : [95m
Header5         : [96m
Header6         : [97m
Code            : [48;2;155;155;155;38;2;30;30;31m
Link            : [4;38;5;117m
Image           : [33m
EmphasisBold    : [1m
EmphasisItalics : [36m

パラメーター

-BoldForegroundColor

太字のマークダウン テキストをレンダリングする前景色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Code

Markdown テキストでコード ブロックとスパンをレンダリングする色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Header1Color

Markdown テキストで Header1 ブロックをレンダリングする色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Header2Color

Markdown テキストで Header2 ブロックをレンダリングする色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Header3Color

Markdown テキストで Header3 ブロックをレンダリングする色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Header4Color

Markdown テキストで Header4 ブロックをレンダリングする色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Header5Color

Markdown テキストで Header5 ブロックをレンダリングする色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Header6Color

Markdown テキストで Header6 ブロックをレンダリングする色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ImageAltTextForegroundColor

Markdown テキスト内の画像要素の代替テキストをレンダリングするための前景色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

設定する構成を含む PSMarkdownOptionInfo オブジェクト。

Type:PSObject
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ItalicsForegroundColor

マークダウン テキストで斜体をレンダリングするための前景色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LinkForegroundColor

Markdown テキストでハイパーリンクをレンダリングする前景色を設定します。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

コマンドレットで、新しい構成を 含む PSMarkdownOptionInfo オブジェクトを出力します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Theme

定義済みの色設定を含むテーマを選択します。 指定できる値は、 濃色 と明るい値 です。

Type:String
Accepted values:Dark, Light
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

入力

PSObject

出力

Microsoft.PowerShell.MarkdownRender.PSMarkdownOptionInfo

メモ

色とスタイルを定義するために使用する文字列値は、正規表現 ^\[*[0-9;]*?m{1}と一致する必要があります。