Package Exports
- vditor-plugin
- vditor-plugin/dist/index.js
- vditor-plugin/dist/index.mjs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vditor-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
vditor-plugin
Vditor plugin helper for Vditor Plugin Development!
Get Started
For Plugin Developer
If you are just working for Vditor plugin development, just focus on the API below:
import { defineVditorPlugin } from "vditor-plugin"
export default defineVditorPlugin({
id: "vditor-plugin-example",
compatible: "1.3.2"
})Arguments of defineVditorPlugin API:
| Argument | Required | Type | Description |
|---|---|---|---|
| id | √ | /vditor\-plugin\-([a-z0-9]+)/ |
Unique identifier of plugin (Consistent with npm packge name) |
| compatible | √ | CompatibleType | Compatible version of Vditor |
| renderers | × | Map<keyof ILuteRender, ILuteRenderCallback> |
Custom Vditor renderers |
| styles | × | Map<string, string> (id, url) |
Custom Vditor Stylesheets |
CompatibleType
- "version"
- ">version"
- "<version"
- ">=version"
- "<=version"
- "*"
- "version1-version2"(including version1, version2)
For Vditor Developer
If you are working for Vditor development, you also need to know the following APIs:
import { checkVditorPluginCompatible, checkVditorPluginIdentifier } from "vditor-plugin"
checkVditorPluginCompatible(">1.3.0", "1.3.1")
// => [true, "1.3.1", "1.3.1"]
checkVditorPluginIdentifier("vditor-plugin-test")
// => [true, "vditor-plugin-test"]checkVditorPluginCompatible(compatible: string, vditor_version: string): Check if the plugin is compatible with the specific version of VditorcheckVditorPluginIdentifier(identifier: string): Check if the identifier of the plugin is valid