Freigeben über


Set-MarkdownOption

Legt die Farben und Formatvorlagen fest, die zum Rendern von Markdown-Inhalten in der Konsole verwendet werden.

Syntax

IndividualSetting (Standardwert)

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

Beschreibung

Legt die Farben und Formatvorlagen fest, die zum Rendern von Markdown-Inhalten in der Konsole verwendet werden. Diese Formatvorlagen werden mithilfe von ANSI-Escapecodes definiert, die die Farbe und die Formatvorlage des gerenderten Markdown-Texts ändern.

Weitere Informationen zu Markdown finden Sie auf der website CommonMark.

Hinweis

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

Beispiele

Beispiel 1 : Wechseln zum hellen Design

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 Formatvorlageneinstellungen

In diesem Beispiel wird der Escapecode für die Markdown-Header geändert. Die Standardkonfiguration für Kopfzeilen rendert sie als unterstrichenen Text verschiedener Farben. Durch diese Änderung wird die Unterstreichungsart 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 formatiertem Markdown-Text fest.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Code

Legt die Farbe für das Rendern von Codeblöcken fest und erstreckt sich in Markdown-Text.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Header1Color

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

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Header2Color

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

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Header3Color

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

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Header4Color

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

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Header5Color

Legt die Farbe für das Rendern von Header5-Blöcken in Markdown-Text fest.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Header6Color

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

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ImageAltTextForegroundColor

Legt die Vordergrundfarbe für das Rendern des alternativen Texts eines Bildelements in Markdown-Text fest.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-InputObject

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

Parametereigenschaften

Typ:PSObject
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

InputObject
Position:0
Obligatorisch.:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ItalicsForegroundColor

Legt die Vordergrundfarbe für das Rendern der Kursivformatierung in Markdown-Text fest.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-LinkForegroundColor

Legt die Vordergrundfarbe für das Rendern von Links in Markdown-Text fest.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

IndividualSetting
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-PassThru

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

Parametereigenschaften

Typ:SwitchParameter
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Theme

Wählt ein Design mit vordefinierten Farbeinstellungen aus. Die möglichen Werte sind Dark und Light.

Parametereigenschaften

Typ:String
Standardwert:None
Zulässige Werte:Dark, Light
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

Theme
Position:Named
Obligatorisch.:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

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.