Set-MarkdownOption

Moduł:

Microsoft.PowerShell.Utility Module

Ustawia kolory i style używane do renderowania zawartości języka Markdown w konsoli programu .

Składnia

IndividualSetting (Domyślna)

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

Opis

Ustawia kolory i style używane do renderowania zawartości języka Markdown w konsoli programu . Te style są definiowane przy użyciu kodów ucieczki ANSI, które zmieniają kolor i styl renderowanego tekstu markdown.

Aby uzyskać więcej informacji na temat języka Markdown, zobacz witrynę internetową CommonMark.

Uwaga / Notatka

Wartości ciągu używane w ustawieniach to znaki następujące po znaku Escape ([char]0x1B) w sekwencji ucieczki ANSI. Nie dołączaj znaku Escape w ciągu. Aby uzyskać więcej informacji na temat działania kodów ucieczki ANSI, zobacz ANSI_escape_code.

Przykłady

Przykład 1 — przełączanie do motywu jasnego

W tym przykładzie wybierany jest motyw Light i nowa konfiguracja jest wyświetlana przy użyciu parametru 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

Przykład 2 — dostosowywanie ustawień koloru i stylu

W tym przykładzie zmienia się kod wyjścia dla nagłówków w języku Markdown. Domyślna konfiguracja nagłówków renderuje je jako podkreślony tekst różnych kolorów. Ta zmiana powoduje usunięcie stylu podkreśleń.

$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

Parametry

-BoldForegroundColor

Ustawia kolor pierwszego planu na potrzeby renderowania tekstu pogrubionego języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Code

Ustawia kolor bloków i zakresów kodu renderowania w tekście języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Header1Color

Ustawia kolor renderowania bloków Header1 w tekście języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Header2Color

Ustawia kolor renderowania bloków Header2 w tekście języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Header3Color

Ustawia kolor renderowania bloków Header3 w tekście języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Header4Color

Ustawia kolor renderowania bloków Header4 w tekście języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Header5Color

Ustawia kolor renderowania bloków Header5 w tekście języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Header6Color

Ustawia kolor renderowania bloków Header6 w tekście języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-ImageAltTextForegroundColor

Ustawia kolor pierwszego planu na potrzeby renderowania alternatywnego tekstu elementu obrazu w tekście języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-InputObject

Obiekt PSMarkdownOptionInfo zawierający konfigurację, która ma zostać ustawiona.

Właściwości parametru

Typ:	PSObject
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

InputObject

Position:	0
Obowiązkowy:	True
Wartość z potoku:	True
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-ItalicsForegroundColor

Ustawia kolor pierwszego planu na potrzeby renderowania kursywy w tekście języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-LinkForegroundColor

Ustawia kolor pierwszego planu na potrzeby renderowania hiperlinków w tekście języka Markdown.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

IndividualSetting

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-PassThru

Powoduje, że polecenie cmdlet zwraca obiekt PSMarkdownOptionInfo zawierający nową konfigurację.

Właściwości parametru

Typ:	SwitchParameter
Domyślna wartość:	None
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

(All)

Position:	Named
Obowiązkowy:	False
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

-Theme

Wybiera motyw zawierający wstępnie zdefiniowane ustawienia kolorów. Możliwe wartości to ciemny i jasny.

Właściwości parametru

Typ:	String
Domyślna wartość:	None
Dopuszczalne wartości:	Dark, Light
Obsługuje symbole wieloznaczne:	False
DontShow:	False

Zestawy parametrów

Theme

Position:	Named
Obowiązkowy:	True
Wartość z potoku:	False
Wartość z potoku według nazwy właściwości:	False
Wartość z pozostałych argumentów:	False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

PSObject

Dane wyjściowe

Microsoft.PowerShell.MarkdownRender.PSMarkdownOptionInfo

Uwagi

Wartości ciągu używane do definiowania koloru i stylu muszą być zgodne z wyrażeniem regularnym ^\[*[0-9;]*?m{1}.

Linki powiązane

• Get-MarkdownOption
• ConvertFrom-Markdown
• Pokaż-Markdown
• Kod_escape_ANSI
• CommonMark