NgDocHighlighterService

Highlights code with Shiki. provideNgDocApp initializes it before the application renders.

Decorators: @Service
Implements: OnDestroy

DeclarationTypeScript

@Service()
export class NgDocHighlighterService implements OnDestroy { … }

Members

Properties

ready: Signal<boolean>

readonly

Whether highlight() can highlight: true once initialize() has finished, and false again after the service is destroyed.

theme: NgDocShikiTheme

protectedreadonly

—

Methods

(…): string

Returns the code as highlighted HTML, or an empty string before initialize() has finished. It reads ready(), so a computed over it updates once Shiki is loaded.

Signature

highlight(code: string): string;

Parameters

Name	Type	Description
code	`string`	Angular HTML to highlight.

Returns

string

(…): Promise<void>

Loads Shiki with the built-in themes (github-light, ayu-dark and NgDoc's css-variables) and the given ones. Concurrent and repeated calls share one initialization; a failed one can be retried.

Signature

initialize(config?: NgDocHighlighterConfig | undefined): Promise<void>;

Parameters

Name	Type	Description
config	`NgDocHighlighterConfig \| undefined`	Custom Shiki themes to load.

Returns

Promise<void>

(): void

implements OnDestroy

Disposes the highlighter this service created for custom themes.

Signature

ngOnDestroy(): void;

Returns

void