Partilhar via

Set-MarkdownOption

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Define as cores e os estilos usados para renderizar o conteúdo de Markdown no console.

Sintaxe

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

Define as cores e os estilos usados para renderizar o conteúdo de Markdown no console. Esses estilos são definidos usando códigos de escape ANSI que alteram a cor e o estilo do texto Markdown que está sendo renderizado.

Para obter mais informações sobre Markdown, consulte o site da CommonMark .

Nota

Os valores de cadeia de caracteres usados nas configurações são os caracteres que seguem o caractere Escape ([char]0x1B) para a sequência de escape ANSI. Não inclua o caractere Escape na cadeia de caracteres. Para obter mais informações sobre o trabalho de códigos de escape ANSI, consulte ANSI_escape_code.

Exemplos

Exemplo 1 - Mudar para o tema Luz

Este exemplo seleciona o tema Light e exibe a nova configuração usando o parâmetro 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

Exemplo 2 - Personalizar as configurações de cor e estilo

Este exemplo altera o código de escape para os cabeçalhos Markdown. A configuração padrão para cabeçalhos os renderiza como texto sublinhado de várias cores. Esta alteração remove o estilo de sublinhado.

$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

Parâmetros

-BoldForegroundColor

Define a cor de primeiro plano para renderizar texto de Markdown em negrito.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Code

Define a cor para renderizar blocos de código e extensões no texto Markdown.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Header1Color

Define a cor para renderizar blocos Header1 no texto Markdown.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Header2Color

Define a cor para renderizar blocos Header2 no texto Markdown.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Header3Color

Define a cor para renderizar blocos Header3 no texto Markdown.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Header4Color

Define a cor para renderizar blocos Header4 no texto Markdown.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Header5Color

Define a cor para renderizar blocos Header5 no texto Markdown.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Header6Color

Define a cor para renderizar blocos Header6 no texto Markdown.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ImageAltTextForegroundColor

Define a cor de primeiro plano para renderizar o texto alternativo de um elemento de imagem no texto Markdown.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-InputObject

Um objeto PSMarkdownOptionInfo que contém a configuração a ser definida.

Tipo:PSObject
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ItalicsForegroundColor

Define a cor de primeiro plano para renderizar o itálico no texto Markdown.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-LinkForegroundColor

Define a cor de primeiro plano para renderizar hiperlinks no texto Markdown.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-PassThru

Faz com que o cmdlet produza um objeto PSMarkdownOptionInfo que contém a nova configuração.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Theme

Seleciona um tema que contém configurações de cores predefinidas. Os valores possíveis são Escuro e Claro.

Tipo:String
Valores aceites:Dark, Light
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

PSObject

Saídas

Microsoft.PowerShell.MarkdownRender.PSMarkdownOptionInfo

Notas

Os valores de cadeia de caracteres usados para definir a cor e o estilo devem corresponder à expressão ^\[*[0-9;]*?m{1}regular.