Skip to content

Vizel API / core/src / VizelCodeBlockOptions

Interface: VizelCodeBlockOptions

Defined in: packages/core/src/extensions/code-block-lowlight.ts:32

Options for creating the code block lowlight extension

Properties

defaultLanguage?

ts
optional defaultLanguage?: string;

Defined in: packages/core/src/extensions/code-block-lowlight.ts:37

Default language for code blocks

Default

ts
"plaintext"

languages?

ts
optional languages?: "common" | "all";

Defined in: packages/core/src/extensions/code-block-lowlight.ts:53

Language loading strategy (ignored if lowlight option is provided).

  • "common": Load ~37 common languages (default, recommended)
  • "all": Load all 190+ languages (larger bundle)

Default

ts
"common"

lineNumbers?

ts
optional lineNumbers?: boolean;

Defined in: packages/core/src/extensions/code-block-lowlight.ts:42

Enable line numbers by default

Default

ts
false

locale?

ts
optional locale?: VizelLocale;

Defined in: packages/core/src/extensions/code-block-lowlight.ts:58

Locale for code block UI strings. If not provided, default English strings are used.


lowlight?

ts
optional lowlight?: object;

Defined in: packages/core/src/extensions/code-block-lowlight.ts:46

Custom lowlight instance. If provided, the languages option is ignored.

Released under the MIT License.