• 简体中文
  • 插件矩阵

    组件分化

    三个入口使用相同的组件 API,按需要选择默认能力:

    组件导入入口定位
    Fluxdownfluxdown 或 fluxdown/full提供更完善的 Markdown 功能和展示效果,适合直接获得完整体验。
    FluxdownLitefluxdown/lite尽量减小体积,提供基础 Markdown 展示,适合按需添加能力。
    FluxdownRawfluxdown/raw自行传入完整的 plugins,按需组合全部能力。

    全部插件

    下表列出 React 组件使用的综合插件。「组成」包含继承的子插件类型;勾选表示对应组件默认包含此插件,空白表示需要手动添加。

    插件组成所在包LiteFull
    BlockquotePluginRender Slotreact-plugins
    BreakLinePluginRender Slotreact-plugins
    CjkPluginRemarkreact-base-plugins
    CodePluginRender Slotreact-plugins
    CodePelePluginSlotreact-plugins
    CodePrismPluginRender Slotreact-plugins
    CodeShikiPluginRender Slotreact-plugins
    EffectChunkPluginRender Slotreact-plugins
    EffectScalePluginRender Slotreact-plugins
    EffectShadPluginRender Slotreact-plugins
    EffectSuffixPluginRender Slotreact-plugins
    EmojiPluginRemarkreact-base-plugins
    EmphasisPluginRender Slotreact-plugins
    FallbackPluginRender Slotreact-plugins
    HeadingPluginRender Slotreact-plugins
    ImagePluginRender Slotreact-plugins
    LinkPluginRender Slotreact-plugins
    ListPluginRender Slotreact-plugins
    ParagraphPluginRender Slotreact-plugins
    PatchPluginRenderreact-base-plugins
    StrongPluginRender Slotreact-plugins
    TablePluginRender Slotreact-plugins
    TexPluginRender Slotreact-plugins
    TexKatexPluginRender Slotreact-plugins
    TexMathjaxKatexPluginRender Slotreact-plugins

    所在包

    • react-plugins 对应 @fluxdown/react-plugins,提供面向 React DOM 的综合插件。
    • react-base-plugins 对应 @fluxdown/react-base-plugins,提供不依赖 DOM 的基础插件,可供其他 React 平台扩展。

    导入规则

    1. 按表格选择插件所在包,使用 <包全名>/plugins/<插件目录> 导入。
    2. 插件目录由导出名称去掉 Plugin 后缀,再转为小写中划线形式。例如,CodePrismPlugin 对应 code-prism,TexMathjaxKatexPlugin 对应 tex-mathjax-katex,CjkPlugin 对应 cjk。
    import { CodePrismPlugin } from '@fluxdown/react-plugins/plugins/code-prism';
    import { CjkPlugin } from '@fluxdown/react-base-plugins/plugins/cjk';

    通过组件的 plugins 参数添加所需插件;声明、组合与配置方式见综合插件。