• English
  • Plugin matrix

    Component variants

    All three entries share the same component API. Choose the default capabilities you need:

    ComponentEntryPurpose
    Fluxdown@fluxdown/taro or @fluxdown/taro/fullFull preset with highlighting, math, CJK and emoji.
    FluxdownLite@fluxdown/taro/liteBasic Markdown presentation, ready to extend.
    FluxdownRaw@fluxdown/taro/rawSupply the complete plugins list and choose every capability.

    All plugins

    Composition includes inherited plugin types. A check means the component includes that plugin by default; an empty cell means it can be added manually.

    PluginCompositionPackageLiteFull
    BlockquotePluginRender Slottaro-plugins
    BreakLinePluginRender Slottaro-plugins
    CjkPluginRemarkreact-base-plugins
    CodePluginRender Slottaro-plugins
    CodePrismPluginRender Slottaro-plugins
    EffectChunkPluginRender Slottaro-plugins
    EffectScalePluginRender Slottaro-plugins
    EffectShadPluginRender Slottaro-plugins
    EffectSuffixPluginRender Slottaro-plugins
    EmojiPluginRemarkreact-base-plugins
    EmphasisPluginRender Slottaro-plugins
    FallbackPluginRender Slottaro-plugins
    HeadingPluginRender Slottaro-plugins
    ImagePluginRender Slottaro-plugins
    LinkPluginRender Slottaro-plugins
    ListPluginRender Slottaro-plugins
    ParagraphPluginRender Slottaro-plugins
    PatchPluginRenderreact-base-plugins
    StrongPluginRender Slottaro-plugins
    TablePluginRender Slottaro-plugins
    TexPluginRender Slottaro-plugins
    TexKatexPluginRender Slottaro-plugins
    TexMathjaxKatexPluginRender Slottaro-plugins

    Package

    taro-plugins refers to @fluxdown/taro-plugins, which provides Taro slots on top of the shared render plugins.

    react-base-plugins refers to @fluxdown/react-base-plugins, which provides shared rendering and syntax plugins.

    Import rules

    Import from <package>/plugins/<plugin-directory>. Remove the Plugin suffix and convert the name to lowercase kebab case: CodePrismPlugin becomes code-prism, and TexMathjaxKatexPlugin becomes tex-mathjax-katex. Use the package shown in the table.

    import { CjkPlugin } from '@fluxdown/react-base-plugins/plugins/cjk';
    import { CodePrismPlugin } from '@fluxdown/taro-plugins/plugins/code-prism';
    import { TexMathjaxKatexPlugin } from '@fluxdown/taro-plugins/plugins/tex-mathjax-katex';

    Import PRESET_FULL_PLUGINS from @fluxdown/taro-plugins/full and PRESET_LITE_PLUGINS from @fluxdown/taro-plugins/lite.

    Pass plugins through the component's plugins prop. See aggregate plugins for declaration, composition and configuration.