• English
  • Plugin matrix

    Component variants

    ComponentEntryIncluded features
    Fluxdown@fluxdown/vue-lynx or @fluxdown/vue-lynx/fullShiki highlighting, SVG math, CJK and Emoji.
    FluxdownLite@fluxdown/vue-lynx/liteBasic Markdown, tables, images and streaming effects.
    FluxdownRaw@fluxdown/vue-lynx/rawRequires your complete plugins list.

    Full highlights Bash, CSS, HTML, JavaScript, JSON, Python and TypeScript. Unrecognized languages remain plain text. Lite displays code as source text.

    build.tex defaults to false. When enabled, Full typesets math with MathJax SVG and requires SVG XElement in the host. Lite displays formula source; add TexMathJaxPlugin for typesetting.

    Code highlighting

    Full uses Shiki highlighting and displays source text while initializing or after an error. Android requires Lynx 3.8 or later with background-thread WebAssembly support. Use CodePrismPlugin for highlighting without WebAssembly.

    All plugins

    Composition includes inherited plugin types. A check means the preset directly includes that plugin. Full's CodeShikiPlugin inherits the base features of CodePlugin.

    PluginCompositionPackageLiteFull
    BlockquotePluginRender Slotvue-lynx-plugins
    BreakLinePluginRender Slotvue-lynx-plugins
    CjkPluginRemarkvue-base-plugins
    CodePluginRender Slotvue-lynx-plugins
    CodePrismPluginRender Slotvue-lynx-plugins
    CodeShikiPluginRender Slotvue-lynx-plugins
    EffectChunkPluginRender Slotvue-lynx-plugins
    EffectScalePluginRender Slotvue-lynx-plugins
    EffectShadPluginRender Slotvue-lynx-plugins
    EffectSuffixPluginRender Slotvue-lynx-plugins
    EmojiPluginRemarkvue-base-plugins
    EmphasisPluginRender Slotvue-lynx-plugins
    FallbackPluginRender Slotvue-lynx-plugins
    HeadingPluginRender Slotvue-lynx-plugins
    ImagePluginRender Slotvue-lynx-plugins
    LinkPluginRender Slotvue-lynx-plugins
    ListPluginRender Slotvue-lynx-plugins
    ParagraphPluginRender Slotvue-lynx-plugins
    PatchPluginRendervue-base-plugins
    StrongPluginRender Slotvue-lynx-plugins
    TablePluginRender Slotvue-lynx-plugins
    TexPluginRender Slotvue-lynx-plugins
    TexMathJaxPluginRender Slotvue-lynx-plugins

    Package and imports

    vue-lynx-plugins is @fluxdown/vue-lynx-plugins, which provides Vue Lynx composite plugins, render plugins and slots.

    Import from @fluxdown/vue-lynx-plugins/plugins/<plugin-directory>. Remove the Plugin suffix from the export name and convert it to lowercase hyphenated words: CodeShikiPlugin becomes code-shiki.

    import { CodeShikiPlugin } from '@fluxdown/vue-lynx-plugins/plugins/code-shiki';
    import { HeadingPlugin } from '@fluxdown/vue-lynx-plugins/plugins/heading';

    Import PRESET_FULL_PLUGINS from @fluxdown/vue-lynx-plugins/full, or PRESET_LITE_PLUGINS from @fluxdown/vue-lynx-plugins/lite, to pass a preset directly to FluxdownRaw.

    The component's plugins prop can extend any preset. See composite plugins for configuration and composition.

    Shared Vue infrastructure

    vue-base-plugins refers to @fluxdown/vue-base-plugins, which provides shared render plugins, CJK, Emoji and Patch. Import from the package listed in the table:

    import { CjkPlugin } from '@fluxdown/vue-base-plugins/plugins/cjk';