Compartilhar via

Set-MarkdownOption

Módulo:
Microsoft.PowerShell.Utility Module

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

Sintaxe

IndividualSetting (Padrão) 

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

Define as cores e os estilos usados para renderizar o conteúdo do 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 o Markdown, consulte o site do CommonMark.

Observação

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 códigos de escape ANSI, consulte ANSI_escape_code.

Exemplos

Exemplo 1 - Alternar para o Tema Claro

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. Essa 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 do primeiro plano para renderizar texto markdown em negrito.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Code

Define a cor para renderizar blocos de código e intervalos no texto markdown.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Header1Color

Define a cor para renderizar blocos Header1 no texto markdown.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Header2Color

Define a cor para renderizar blocos Header2 no texto Markdown.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Header3Color

Define a cor para renderizar blocos Header3 no texto markdown.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Header4Color

Define a cor para renderizar blocos Header4 no texto Markdown.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Header5Color

Define a cor para renderizar blocos de Cabeçalho5 no texto markdown.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Header6Color

Define a cor para renderizar blocos Header6 no texto markdown.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ImageAltTextForegroundColor

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

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

Propriedades do parâmetro

Tipo:PSObject
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

InputObject
Cargo:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ItalicsForegroundColor

Define a cor do primeiro plano para renderizar os itálicos no texto markdown.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-LinkForegroundColor

Define a cor do primeiro plano para renderizar hiperlinks no texto markdown.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

IndividualSetting
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PassThru

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Theme

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Valores aceitos:Dark, Light
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Theme
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSObject

Saídas

Microsoft.PowerShell.MarkdownRender.PSMarkdownOptionInfo

Observações

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