New-UDSyntaxHighlighter

Synopsis

Syntax highlighting for text.

Syntax

New-UDSyntaxHighlighter [[-Id] <String>] [[-Code] <String>] [[-Language] <String>] [[-Style] <String>] [-ShowLineNumbers] [<CommonParameters>]

Description

Syntax highlighting for text.

Parameters

-Id

The ID of this component.

Required?                    false
Position?                    1
Default value                [Guid]::NewGuid()
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Code

The code to syntax highlight.

Required?                    false
Position?                    2
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Language

The language to highlight the code in.

Required?                    false
Position?                    3
Default value                powershell
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Style

The style to apply to the code.

Required?                    false
Position?                    4
Default value                oneDark
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ShowLineNumbers

Whether to show line numbers.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

Common parameters

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.

Outputs

Examples

Example 1: Basic Syntax Highlighter

New-UDSyntaxHighlighter -Code 'Write-Host "Hello World"' -Language powershell

A basic syntax highlighter.

Example 2: Style

New-UDSyntaxHighlighter -Code 'Write-Host "Hello World"' -Language powershell -Style 'vs'

A syntax highlighter with a style.

Example 3: Line Numbers

New-UDSyntaxHighlighter -Code 'Write-Host "Hello World"' -Language powershell -ShowLineNumbers

A syntax highlighter with line numbers.