• English

      • Plugin matrix

      Component variants

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

      ComponentEntryPurpose
      Fluxdown@fluxdown/vue or @fluxdown/vue/fullFull preset with highlighting, math and diagrams.
      FluxdownLite@fluxdown/vue/liteBasic Markdown presentation, ready to extend.
      FluxdownRaw@fluxdown/vue/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 Slotvue-plugins
      BreakLinePluginRender Slotvue-plugins
      CjkPluginRemarkvue-plugins
      CodePluginRender Slotvue-plugins
      CodePelePluginSlotvue-plugins
      CodePrismPluginRender Slotvue-plugins
      CodeShikiPluginRender Slotvue-plugins
      EffectChunkPluginRender Slotvue-plugins
      EffectScalePluginRender Slotvue-plugins
      EffectShadPluginRender Slotvue-plugins
      EffectSuffixPluginRender Slotvue-plugins
      EmojiPluginRemarkvue-plugins
      EmphasisPluginRender Slotvue-plugins
      FallbackPluginRender Slotvue-plugins
      HeadingPluginRender Slotvue-plugins
      ImagePluginRender Slotvue-plugins
      LinkPluginRender Slotvue-plugins
      ListPluginRender Slotvue-plugins
      ParagraphPluginRender Slotvue-plugins
      PatchPluginRendervue-plugins
      StrongPluginRender Slotvue-plugins
      TablePluginRender Slotvue-plugins
      TexPluginRender Slotvue-plugins
      TexKatexPluginRender Slotvue-plugins
      TexMathjaxKatexPluginRender Slotvue-plugins

      Package

      vue-plugins refers to @fluxdown/vue-plugins, which provides aggregate plugins, renderers and slots for Vue.

      Import rules

      Import from @fluxdown/vue-plugins/plugins/<plugin-directory>. Remove the Plugin suffix and convert the name to lowercase kebab case: CodeShikiPlugin becomes code-shiki, and TexMathjaxKatexPlugin becomes tex-mathjax-katex.

      import { CodeShikiPlugin } from '@fluxdown/vue-plugins/plugins/code-shiki';
import { TexMathjaxKatexPlugin } from '@fluxdown/vue-plugins/plugins/tex-mathjax-katex';

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

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