Set-MarkdownOption

  • Référence
Module:
Microsoft.PowerShell.Utility

Définit les couleurs et les styles utilisés pour le rendu du contenu Markdown dans la console.

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

Définit les couleurs et les styles utilisés pour le rendu du contenu Markdown dans la console. Ces styles sont définis à l’aide de codes d’échappement ANSI qui modifient la couleur et le style du texte Markdown en cours de rendu.

Pour plus d’informations sur Markdown, consultez le site web CommonMark .

Remarque

Les valeurs de chaîne utilisées dans les paramètres sont les caractères qui suivent le caractère d’échappement ([char]0x1B) de la séquence d’échappement ANSI. N’incluez pas le caractère d’échappement dans la chaîne. Pour plus d’informations sur le travail des codes d’échappement ANSI, consultez ANSI_escape_code.

Exemples

Exemple 1 : basculer vers le thème clair

Cet exemple montre comment sélectionner le thème Light et afficher la nouvelle configuration à l’aide du paramètre 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

Exemple 2 : Personnaliser les paramètres de couleur et de style

Cet exemple montre comment modifier le code d’échappement des en-têtes Markdown. La configuration par défaut pour les en-têtes les restitue sous forme de texte souligné de différentes couleurs. Cette modification supprime le style de soulignement.

$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

Paramètres

-BoldForegroundColor

Définit la couleur de premier plan pour le rendu du texte Markdown en gras.

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

-Code

Définit la couleur du rendu des blocs de code et des étendues dans le texte Markdown.

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

-Header1Color

Définit la couleur du rendu des blocs Header1 dans le texte Markdown.

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

-Header2Color

Définit la couleur du rendu des blocs Header2 dans le texte Markdown.

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

-Header3Color

Définit la couleur du rendu des blocs Header3 dans le texte Markdown.

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

-Header4Color

Définit la couleur du rendu des blocs Header4 dans le texte Markdown.

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

-Header5Color

Définit la couleur du rendu des blocs Header5 dans le texte Markdown.

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

-Header6Color

Définit la couleur du rendu des blocs Header6 dans le texte Markdown.

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

-ImageAltTextForegroundColor

Définit la couleur de premier plan pour le rendu du texte de remplacement d’un élément d’image dans le texte Markdown.

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

-InputObject

Objet PSMarkdownOptionInfo contenant la configuration à définir.

Type:PSObject
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ItalicsForegroundColor

Définit la couleur de premier plan pour le rendu des italiques dans le texte Markdown.

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

-LinkForegroundColor

Définit la couleur de premier plan pour le rendu des liens hypertexte dans le texte Markdown.

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

-PassThru

Provoque la sortie d’un objet PSMarkdownOptionInfo contenant la nouvelle configuration.

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

-Theme

Sélectionne un thème contenant des paramètres de couleur prédéfinis. Les valeurs possibles sont sombres et claires.

Type:String
Accepted values:Dark, Light
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Entrées

PSObject

Sorties

Microsoft.PowerShell.MarkdownRender.PSMarkdownOptionInfo

Notes

Les valeurs de chaîne utilisées pour définir la couleur et le style doivent correspondre à l’expression ^\[*[0-9;]*?m{1}régulière.