• English
  • Plugin matrix

    Component variants

    All three entry points share their props. Choose the preset you need:

    ComponentImportPurpose
    Fluxdown@fluxdown/uni-app or @fluxdown/uni-app/fullFull preset with highlighting, math, diagrams, CJK, and emoji shortcodes.
    FluxdownLite@fluxdown/uni-app/liteBasic Markdown and streaming effects; add other capabilities as needed.
    FluxdownRaw@fluxdown/uni-app/rawRequires explicit plugins to assemble your own capabilities.

    All plugins

    Composition includes inherited plugin types. A check means the preset includes the plugin by default.

    PluginCompositionPackageLiteFull
    BlockquotePluginRender Slotuni-app-plugins
    BreakLinePluginRender Slotuni-app-plugins
    CjkPluginRemarkuni-app-plugins
    CodePluginRender Slotuni-app-plugins
    CodePelePluginSlotuni-app-plugins
    CodePrismPluginRender Slotuni-app-plugins
    EffectChunkPluginRender Slotuni-app-plugins
    EffectScalePluginRender Slotuni-app-plugins
    EffectShadPluginRender Slotuni-app-plugins
    EffectSuffixPluginRender Slotuni-app-plugins
    EmojiPluginRemarkuni-app-plugins
    EmphasisPluginRender Slotuni-app-plugins
    FallbackPluginRender Slotuni-app-plugins
    HeadingPluginRender Slotuni-app-plugins
    ImagePluginRender Slotuni-app-plugins
    LinkPluginRender Slotuni-app-plugins
    ListPluginRender Slotuni-app-plugins
    ParagraphPluginRender Slotuni-app-plugins
    PatchPluginRenderuni-app-plugins
    StrongPluginRender Slotuni-app-plugins
    TablePluginRender Slotuni-app-plugins
    TexPluginRender Slotuni-app-plugins
    TexKatexPluginRender Slotuni-app-plugins
    TexMathjaxPluginRender Slotuni-app-plugins
    TexMathjaxKatexPluginRender Slotuni-app-plugins

    Shiki is not included yet: the App JavaScript bytecode runtime does not support Unicode property escapes in new RegExp(...). CodePrismPlugin provides highlighting across platforms.

    TexPlugin preserves formula source. The three formula renderers require build.tex: true to parse formula syntax.

    Formulas are rendered as SVG images. The KaTeX plugins use KaTeX to parse formulas and MathJax for SVG layout, so their glyphs can differ from KaTeX’s default output. TexMathjaxKatexPlugin falls back to MathJax’s TeX parser for commands KaTeX does not support.

    Package

    uni-app-plugins means @fluxdown/uni-app-plugins, which provides Uni App composite plugins, render plugins, and slots.

    Import paths

    Import from @fluxdown/uni-app-plugins/plugins/<directory>. Remove the Plugin suffix and convert the remaining name to lowercase with hyphens: CodePrismPlugin becomes code-prism.

    import { CodePrismPlugin } from '@fluxdown/uni-app-plugins/plugins/code-prism';
    import { TexMathjaxKatexPlugin } from '@fluxdown/uni-app-plugins/plugins/tex-mathjax-katex';

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

    Add capabilities through plugins; see Composite plugins for declaration and composition.