Class Highlighter

Namespace

BlazOrbit.SyntaxHighlight

Assembly

BlazOrbit.SyntaxHighlight.dll

Provides syntax highlighting for multiple programming languages by tokenizing code and rendering it as HTML.

public sealed class Highlighter

Inheritance

object

Highlighter

Constructors

Highlighter()

Initializes a new instance of the Highlighter class with default render options.

public Highlighter()

Highlighter(HtmlRenderOptions)

Initializes a new instance of the Highlighter class with the specified render options.

public Highlighter(HtmlRenderOptions options)

Parameters

options HtmlRenderOptions

The HTML render options.

Properties

Options

Gets or sets the HTML render options used for highlighting.

public HtmlRenderOptions Options { get; set; }

Property Value

HtmlRenderOptions

Methods

GetRegisteredLanguages()

Returns the registered language identifiers.

public IEnumerable<string> GetRegisteredLanguages()

Returns

IEnumerable<string>

A collection of registered language names.

HasLanguage(string)

Determines whether the specified language is registered.

public bool HasLanguage(string name)

Parameters

name string

The language name to check.

Returns

bool

true if the language is registered; otherwise, false.

Highlight(string, string)

Highlights the specified code using the given language and returns HTML.

public string Highlight(string language, string code)

Parameters

language string

The language identifier.

code string

The code to highlight.

Returns

string

The highlighted HTML output.

RegisterLanguage(string, LanguageDefinition)

Registers a language definition with the specified name.

public void RegisterLanguage(string name, LanguageDefinition definition)

Parameters

name string

The language name.

definition LanguageDefinition

The language definition.

RegisterLanguage(string[], LanguageDefinition)

Registers a language definition with multiple aliases.

public void RegisterLanguage(string[] aliases, LanguageDefinition definition)

Parameters

aliases string[]

The language aliases.

definition LanguageDefinition

The language definition.

Tokenize(string, string)

Tokenizes the specified code using the given language.

public IReadOnlyList<Token> Tokenize(string language, string code)

Parameters

language string

The language identifier.

code string

The code to tokenize.

Returns

IReadOnlyList<Token>

A read-only list of tokens.