• English
  • Plugin matrix

    Component variants

    ComponentEntryIncluded features
    Fluxdown@fluxdown/react-lynx or @fluxdown/react-lynx/fullShiki highlighting, SVG math, CJK and Emoji.
    FluxdownLite@fluxdown/react-lynx/liteBasic Markdown, tables, images and streaming effects.
    FluxdownRaw@fluxdown/react-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 Slotreact-lynx-plugins
    BreakLinePluginRender Slotreact-lynx-plugins
    CjkPluginRemarkreact-lynx-plugins
    CodePluginRender Slotreact-lynx-plugins
    CodePrismPluginRender Slotreact-lynx-plugins
    CodeShikiPluginRender Slotreact-lynx-plugins
    EffectChunkPluginRender Slotreact-lynx-plugins
    EffectScalePluginRender Slotreact-lynx-plugins
    EffectShadPluginRender Slotreact-lynx-plugins
    EffectSuffixPluginRender Slotreact-lynx-plugins
    EmojiPluginRemarkreact-lynx-plugins
    EmphasisPluginRender Slotreact-lynx-plugins
    FallbackPluginRender Slotreact-lynx-plugins
    HeadingPluginRender Slotreact-lynx-plugins
    ImagePluginRender Slotreact-lynx-plugins
    LinkPluginRender Slotreact-lynx-plugins
    ListPluginRender Slotreact-lynx-plugins
    ParagraphPluginRender Slotreact-lynx-plugins
    PatchPluginRenderreact-lynx-plugins
    StrongPluginRender Slotreact-lynx-plugins
    TablePluginRender Slotreact-lynx-plugins
    TexPluginRender Slotreact-lynx-plugins
    TexMathJaxPluginRender Slotreact-lynx-plugins

    Package and imports

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

    Import from @fluxdown/react-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/react-lynx-plugins/plugins/code-shiki';
    import { HeadingPlugin } from '@fluxdown/react-lynx-plugins/plugins/heading';

    Import PRESET_FULL_PLUGINS from @fluxdown/react-lynx-plugins/full, or PRESET_LITE_PLUGINS from @fluxdown/react-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.