• English
  • Plugin matrix

    Component variants

    ComponentEntryIncluded features
    Fluxdown@fluxdown/lynx or @fluxdown/lynx/fullAdds Shiki highlighting, CJK and Emoji to the base features.
    FluxdownLite@fluxdown/lynx/liteBasic Markdown, tables, images and streaming effects.
    FluxdownRaw@fluxdown/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.

    Both presets provide a Tex slot. build.tex defaults to false; enabling it displays formula source. Add TexSvgPlugin and integrate SVG XElement in the host to typeset math.

    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 Slotlynx-plugins
    BreakLinePluginRender Slotlynx-plugins
    CjkPluginRemarklynx-plugins
    CodePluginRender Slotlynx-plugins
    CodeShikiPluginRender Slotlynx-plugins
    EffectChunkPluginRender Slotlynx-plugins
    EffectScalePluginRender Slotlynx-plugins
    EffectShadPluginRender Slotlynx-plugins
    EffectSuffixPluginRender Slotlynx-plugins
    EmojiPluginRemarklynx-plugins
    EmphasisPluginRender Slotlynx-plugins
    FallbackPluginRender Slotlynx-plugins
    HeadingPluginRender Slotlynx-plugins
    ImagePluginRender Slotlynx-plugins
    LinkPluginRender Slotlynx-plugins
    ListPluginRender Slotlynx-plugins
    ParagraphPluginRender Slotlynx-plugins
    PatchPluginRenderlynx-plugins
    StrongPluginRender Slotlynx-plugins
    TablePluginRender Slotlynx-plugins
    TexPluginRender Slotlynx-plugins
    TexSvgPluginRender Slotlynx-plugins

    Package and imports

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

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

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