vitepress-linkcard
    Preparing search index...

    Interface LinkToCardPluginOptions

    Configuration options for the link-to-card plugin.

    This interface defines the customization options available when using the vitepress-linkcard plugin. The plugin converts specially-formatted markdown links (prefixed with @:) into rich link preview cards with Open Graph Protocol (OGP) metadata.

    import { linkToCardPlugin } from 'vitepress-linkcard'

    markdownIt.use(linkToCardPlugin, {
      target: '_blank'
    })
    interface LinkToCardPluginOptions {
        classPrefix?: string;
        render?: CardDomRender;
        target?: ATarget;
    }
    Index

    Properties

    classPrefix? render? target?

    Properties

    classPrefix?: string

    CSS class name prefix for the card DOM elements. When set, no inline styles are injected; only the class names are applied.

    `'my-docs__link-card'`
    render?: CardDomRender

    Custom function to render the DOM fragment for the link card. When provided, this function is used instead of the default card renderer.

    target?: ATarget

    Where to display the linked URL.

    '_blank' - Opens the link in a new tab/window

    Settings

    Member Visibility

    On This Page

    Properties