Skip to content

Vizel API / core/src / composeVizelMarkdownFlavors

Function: composeVizelMarkdownFlavors()

ts
function composeVizelMarkdownFlavors(flavors, name?): VizelMarkdownFlavor;

Defined in: packages/core/src/markdown/flavors/compose.ts:24

Combine multiple flavors into a single derived flavor.

Later entries override earlier ones:

  • markdownItPlugins are concatenated in order, so a later parser plugin that conflicts with an earlier one wins.
  • nodeSerializers / markSerializers are merged key-by-key with later values replacing earlier values.
  • config is shallow-merged with later values winning.

name defaults to a hyphenated concatenation of the input names ("gfm-obsidian"); pass name to override.

Parameters

ParameterType
flavorsreadonly VizelMarkdownFlavor[]
name?string

Returns

VizelMarkdownFlavor

Example

ts
const custom = composeVizelMarkdownFlavors(
  [vizelGfmFlavor, vizelObsidianFlavor],
  "gfm-obsidian"
);

Released under the MIT License.