• 简体中文

      • 使用与编写插件

      插件按内容处理过程分工。调整组件和交互，从 slot 开始；需要改变节点对应的插槽，再使用 render。解析、修复和流式映射由 Core 插件处理。

      类型作用编写指南
      slot渲染插槽，提供组件和交互。Slot 插件
      render将 HAST 节点渲染成插槽。Render 插件
      mapper响应式映射 HAST，控制内容逐步呈现。Mapper 插件
      remark解析 Markdown 语法。Remark 插件
      rehype对 HAST 做二次处理。Rehype 插件
      repair处理 Markdown AST，修复未完成内容。Repair 插件

      使用插件包

      plugins 接收一个 IPluginItem 或它的数组。一个对象可以包含 slots、renders、remarks、rehypes、repairs 和 mappers 中的多个列表。

      IPluginItem 从 @fluxdown/lynx-plugins/typings 导入。

      import { FluxdownLite } from '@fluxdown/lynx/lite';
import { CodeShikiPlugin } from '@fluxdown/lynx-plugins/plugins/code-shiki';

type MessageProps = {
  text: string;
};

export function Message({ text }: MessageProps) {
  return <FluxdownLite plugins={CodeShikiPlugin} text={text} />;
}

      这个例子为 Lite 添加代码高亮。多个插件包可以按顺序放进数组；相同优先级下，后面的 render 先匹配，后面的 slot 通过 Raw 包裹前面的组件。

      单独添加插件时，先安装 @fluxdown/lynx-plugins，再从它的 plugins/<小写中划线目录> 子路径导入。

      配置与扩展

      config 按插件的 key 提供选项，只作用于同一个对象列表中明确列出的插件。声明与组合示例见综合插件。

      内置插件及 Full、Lite 的区别见插件矩阵。需要完全自行组装时，使用 @fluxdown/lynx/raw 的 FluxdownRaw。

      自定义解析插件

      内置预设和插件包已处理后台线程边界。自己编写的模块若引入 Core 或解析库，需要只在后台线程加载：在模块中加入 import 'background-only'，并在调用处使用 plugins={__BACKGROUND__ ? customPlugins : []}。

      这样解析逻辑留在后台线程，组件仍可使用普通 ReactLynx 元素。仅调整插槽时，无需引入解析库。