Class DefaultSyntaxHighlighterService

constructor

• new DefaultSyntaxHighlighterService(): DefaultSyntaxHighlighterService

  Returns DefaultSyntaxHighlighterService

colorEnabled

colorFunction

getRegisteredSyntaxes

• getRegisteredSyntaxes(): readonly string[]

  Return the names of the currently registered syntaxes.

  Returns readonly string[]

highlight

• highlight(text: string, syntaxName: string, colorScheme?: ColorScheme): string

  Return a syntactically highlighted version of the provided text using the specified syntax. The returned text will include appropriate color styling. An optional ColorScheme can be provided.

  Parameters

  • text: string

    the text to highlight.

  • syntaxName: string

    the syntax to use.

  • OptionalcolorScheme: ColorScheme

    the color scheme to use.

  Returns string

registerSyntax

• registerSyntax(syntaxName: string, syntaxDefinition: LanguageFn): void

  Register a new syntax.

  The recommended way to define a new language syntax is to follow the instructions here:

  • https://highlightjs.readthedocs.io/en/latest/language-contribution.html
  • https://highlightjs.readthedocs.io/en/latest/building-testing.html
  • https://github.com/highlightjs/highlight.js/blob/main/docs/language-guide.rst

  There is a list of already defined languages available for import here:

  https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md

  Parameters

  • syntaxName: string

    the name used to refer to the syntax.

  • syntaxDefinition: LanguageFn

    the definition for the syntax conforming to the Highlight JS language definition syntax.

  Returns void