Поиск по сайту:

Set-MarkdownOption (Microsoft.PowerShell.Utility)

Set-MarkdownOption

Модуль:
Microsoft.PowerShell.Utility

Устанавливает цвета и стили, используемые для рендеринга содержимого Markdown в консоли.

Синтаксис

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

Описание

Устанавливает цвета и стили, используемые для рендеринга содержимого Markdown в консоли. Эти стили определяются с помощью escape-кодов ANSI, которые изменяют цвет и стиль отображаемого текста Markdown.

Дополнительную информацию о Markdown см. на веб-сайте CommonMark.

Примечание

Строковые значения, используемые в настройках, — это символы, следующие за символом Escape ([char]0x1B) для escape-последовательности ANSI. Не включайте в строку символ Escape. Дополнительные сведения о работе escape-кодов ANSI см. в разделе ANSI_escape_code.

Примеры

Пример 1. Переключение на светлую тему

В этом примере выбирается тема Светлая и отображается новая конфигурация с использованием параметра 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

Пример 2. Настройка параметров цвета и стиля

В этом примере изменяется escape-код для заголовков Markdown. Конфигурация по умолчанию для заголовков отображает их как подчеркнутый текст разных цветов. Это изменение удаляет стиль подчеркивания.

$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

Параметры

-BoldForegroundColor

Устанавливает цвет переднего плана для отображения жирного текста Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Code

Задает цвет для рендеринга блоков и диапазонов кода в тексте Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Header1Color

Задает цвет для отображения блоков Header1 в тексте Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Header2Color

Устанавливает цвет для рендеринга блоков Header2 в тексте Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Header3Color

Устанавливает цвет для рендеринга блоков Header3 в тексте Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Header4Color

Устанавливает цвет для рендеринга блоков Header4 в тексте Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Header5Color

Устанавливает цвет для рендеринга блоков Header5 в тексте Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Header6Color

Устанавливает цвет для рендеринга блоков Header6 в тексте Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-ImageAltTextForegroundColor

Устанавливает цвет переднего плана для рендеринга альтернативного текста элемента изображения в тексте Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-InputObject

Объект PSMarkdownOptionInfo, содержащий настраиваемую конфигурацию.

Тип :

PSОбъект

Позиция:

0

Значение по умолчанию:

None

Необходимый:

True

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

False

-ItalicsForegroundColor

Устанавливает цвет переднего плана для отрисовки курсива в тексте Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-LinkForegroundColor

Устанавливает цвет переднего плана для отображения гиперссылок в тексте Markdown.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-PassThru

Заставляет командлет выводить объект PSMarkdownOptionInfo, содержащий новую конфигурацию.

Тип :

SwitchParameter

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Theme

Выбирает тему, содержащую предопределенные настройки цвета. Возможные значения: Темный и Светлый.

Тип :

String

Принятые значения:

Темный, Светлый

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

True

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

Входы

PSObject

Выходы

Microsoft.PowerShell.MarkdownRender.PSMarkdownOptionInfo

Примечания

Строковые значения, используемые для определения цвета и стиля, должны соответствовать регулярному выражению ^\[*[0-9;]*?m{1}.