Set-MarkdownOption

  • 參考
模組:
Microsoft.PowerShell.Utility

設定用於在控制台中轉譯 Markdown 內容的色彩和樣式。

Syntax

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>]

Description

設定用於在控制台中轉譯 Markdown 內容的色彩和樣式。 這些樣式是使用 ANSI 逸出程式代碼來定義，以變更要轉譯之 Markdown 文字的色彩和樣式。

如需 Markdown 的詳細資訊，請參閱 CommonMark 網站。

注意

設定中使用的字串值是 ANSI 逸出序列的 逸 出字元 （[char]0x1B） 後面的字元。 請勿在 字串中包含 Escape 字元。 如需 ANSI 逸出碼運作的詳細資訊，請參閱 ANSI_escape_code。

範例

範例 1 - 切換至淺色主題

此範例會選取淺色主題，並使用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

設定呈現粗體 Markdown 文字的前景色彩。

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

設定在 Markdown 文字中呈現斜體的前景色彩。

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

導致 Cmdlet 輸出 包含新組態的 PSMarkdownOptionInfo 物件。

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

-Theme

選取包含預先定義色彩設定的主題。 可能的值為 Dark 和 Light。

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}。