Share via

Set-MarkdownOption

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Legt die Farben und Stile fest, die zum Rendern von Markdowninhalten in der Konsole verwendet werden.

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

Beschreibung

Legt die Farben und Stile fest, die zum Rendern von Markdowninhalten in der Konsole verwendet werden. Diese Formatvorlagen werden mithilfe von ANSI-Escapecodes definiert, die die Farbe und den Stil des gerenderten Markdowntexts ändern.

Weitere Informationen zu Markdown finden Sie auf der CommonMark-Website .

Hinweis

Die in den Einstellungen verwendeten Zeichenfolgenwerte sind die Zeichen, die dem Escapezeichen ([char]0x1B) für die ANSI-Escapesequenz folgen. Schließen Sie das Escapezeichen nicht in die Zeichenfolge ein. Weitere Informationen zur Funktionsweise von ANSI-Escapecodes finden Sie unter ANSI_escape_code.

Beispiele

Beispiel 1: Wechseln zum Lichtdesign

In diesem Beispiel wird das Design Light ausgewählt und die neue Konfiguration mithilfe des PassThru-Parameters angezeigt.

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

Beispiel 2: Anpassen der Farb- und Stileinstellungen

In diesem Beispiel wird der Escapecode für die Markdownheader geändert. Die Standardkonfiguration für Header rendert sie als unterstrichenen Text in verschiedenen Farben. Durch diese Änderung wird der Unterstrichsstil entfernt.

$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

Parameter

-BoldForegroundColor

Legt die Vordergrundfarbe für das Rendern von fett markiertem Text fest.

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

-Code

Legt die Farbe für das Rendern von Codeblöcken und Spannen im Markdowntext fest.

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

-Header1Color

Legt die Farbe für das Rendern von Header1-Blöcken in Markdowntext fest.

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

-Header2Color

Legt die Farbe für das Rendern von Header2-Blöcken in Markdowntext fest.

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

-Header3Color

Legt die Farbe für das Rendern von Header3-Blöcken in Markdowntext fest.

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

-Header4Color

Legt die Farbe für das Rendern von Header4-Blöcken in Markdowntext fest.

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

-Header5Color

Legt die Farbe für das Rendern von Header5-Blöcken im Markdowntext fest.

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

-Header6Color

Legt die Farbe für das Rendern von Header6-Blöcken in Markdowntext fest.

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

-ImageAltTextForegroundColor

Legt die Vordergrundfarbe zum Rendern des alternativen Texts eines Bildelements in Markdowntext fest.

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

-InputObject

Ein PSMarkdownOptionInfo-Objekt , das die festzulegende Konfiguration enthält.

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

-ItalicsForegroundColor

Legt die Vordergrundfarbe für das Rendern der Kursivschrift in Markdowntext fest.

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

-LinkForegroundColor

Legt die Vordergrundfarbe für das Rendern von Hyperlinks in Markdowntext fest.

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

-PassThru

Bewirkt, dass das Cmdlet ein PSMarkdownOptionInfo-Objekt ausgibt, das die neue Konfiguration enthält.

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

-Theme

Wählt ein Design aus, das vordefinierte Farbeinstellungen enthält. Die möglichen Werte sind Dunkel und Hell.

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

Eingaben

PSObject

Ausgaben

Microsoft.PowerShell.MarkdownRender.PSMarkdownOptionInfo

Hinweise

Die Zeichenfolgenwerte, die zum Definieren der Farbe und des Stils verwendet werden, müssen mit dem regulären Ausdruck ^\[*[0-9;]*?m{1}übereinstimmen.