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 内容的颜色和样式。 这些样式是使用 ANSI 转义代码定义的，可以更改所要呈现的 Markdown 文本的颜色和样式。

有关 Markdown 的详细信息，请参阅 CommonMark 网站。

注意

设置中使用的字符串值是 ANSI 转义序列的转义字符 ([char]0x1B) 后面的字符。 请不要在字符串中包含转义字符。 有关 ANSI 转义代码如何工作的详细信息，请参阅 ANSI_escape_code。

示例

示例 1 - 切换到 Light 主题

此示例选择 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

设置用于呈现粗体 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} 匹配。