Set-MarkdownOption

設定用於在控制台中渲染 Markdown 內容的顏色和樣式。

語法

IndividualSetting (預設值)

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

Theme

Set-MarkdownOption
    -Theme <String>
    [-PassThru]
    [<CommonParameters>]

InputObject

Set-MarkdownOption
    [-InputObject] <PSObject>
    [-PassThru]
    [<CommonParameters>]

Description

設定用於在控制台中渲染 Markdown 內容的顏色和樣式。 這些樣式是透過 ANSI 跳脫碼定義的,這些碼會改變被渲染的 Markdown 文字的顏色與樣式。

欲了解更多 Markdown 資訊,請參閱 CommonMark 官方網站。

Note

設定中使用的字串值是 ANSI 轉義序列中緊接 Escape 字[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

範例二 - 自訂顏色與樣式設定

此範例改變了 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 文字。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Code

設定 Markdown 文字中渲染程式碼區塊和區間的顏色。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Header1Color

設定 Markdown 文字中 Header1 區塊的顏色。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Header2Color

設定 Markdown 文字中 Header2 區塊的渲染顏色。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Header3Color

設定 Markdown 文字中 Header3 區塊的渲染顏色。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Header4Color

設定 Markdown 文字中 Header4 區塊的渲染顏色。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Header5Color

設定 Markdown 文字中 Header5 區塊的渲染顏色。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Header6Color

設定 Markdown 文字中 Header6 區塊的渲染顏色。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ImageAltTextForegroundColor

設定 Markdown 文字中影像元素替代文字的前景顏色。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-InputObject

一個包含要設定的 PSMarkdownOptionInfo 物件。

參數屬性

類型:PSObject
預設值:None
支援萬用字元:False
不要顯示:False

參數集

InputObject
Position:0
必要:True
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ItalicsForegroundColor

設定 Markdown 文字中斜體字的前景顏色。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-LinkForegroundColor

設定 Markdown 文字中超連結渲染的前景顏色。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

IndividualSetting
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PassThru

會讓 cmdlet 輸出一個包含新配置的 PSMarkdownOptionInfo 物件。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Theme

選擇包含預設色彩設定的主題。 可能的數值是暗與淺。

參數屬性

類型:String
預設值:None
接受的值:Dark, Light
支援萬用字元:False
不要顯示:False

參數集

Theme
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 cmdlet 支援常見參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。

輸入

PSObject

輸出

Microsoft.PowerShell.MarkdownRender.PSMarkdownOptionInfo

備註

用來定義顏色與樣式的字串值必須與正則表達式 ^\[*[0-9;]*?m{1}相符。