#Remark plugins

Remark plugins run while Markdown is parsed into its syntax tree, MDAST. Use them to add a syntax extension or adapt an existing unified remark plugin.

#Declare a plugin

For example, remark-cjk-friendly improves emphasis parsing around Chinese, Japanese, and Korean punctuation:

pnpm add @fluxdown/core-plugins remark-cjk-friendly

import { BaseRemarkPlugin } from '@fluxdown/core-plugins/plugins/remark/base';
import remarkCjkFriendly from 'remark-cjk-friendly';

class CjkSyntaxPlugin extends BaseRemarkPlugin {
  static readonly key = 'remark-cjk-syntax';

  readonly plugin = remarkCjkFriendly;
}

const remarks = [CjkSyntaxPlugin];

key identifies the plugin. plugin is the unified plugin that registers the syntax extension. Core already supplies the Markdown parser.

#Use it

Add remarks to the Core inputs from the quick start. Existing presets stay enabled.

If your unified plugin needs options, accept them in the class constructor and create a plugin function that closes over those options. Pass them as [YourPlugin, options].

remark extensions can also transform MDAST. Use repair when the change should follow Core's repair switches or target the streaming tail.

#Supported plugins

Append a subpath from the table to @fluxdown/core-plugins/plugins/remark/ to import a plugin. For example, code-meta becomes @fluxdown/core-plugins/plugins/remark/code-meta.

A check marks plugins included in PRESET_REMARK_PLUGINS, exported from @fluxdown/core-plugins/presets/remark. Core registers these automatically; add plugins without a check explicitly.