Plugin Factory

Defined in: packages/megadoc-plugin-js/lib/index.js

Instance Constructor Documentation

Plugin(userConfig: Config)

Parameters (1)

userConfig
Config

Instance Method Documentation

    defineCustomTag(tagName: String, definition: Object)

    Add a custom-tag definition.

    Parameters (4)

    tagName
    String
    definition
    Object
    definition.attributes
    Array.<String>

    A whitelist of all the custom attributes the tag defines.

    Attempting to define an attribute that is not listed here will raise an error.

    definition.withTypeInfo
    Boolean

    Whether the tag is expected to have type info, like:

    Defaults to: false