https://github.com/herberthe/vditor-plugin

Vditor plugin helper for Vditor Plugin Development!
https://github.com/herberthe/vditor-plugin

Last synced: about 1 month ago
JSON representation

Vditor plugin helper for Vditor Plugin Development!

• Host: GitHub
• URL: https://github.com/herberthe/vditor-plugin
• Owner: HerbertHe
• License: mit
• Created: 2022-02-12T11:14:19.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-22T09:36:53.000Z (over 2 years ago)
• Last Synced: 2024-11-07T00:44:24.391Z (about 2 months ago)
• Language: TypeScript
• Size: 87.9 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vditor-plugin

[![version](https://img.shields.io/npm/v/vditor-plugin.svg)](https://www.npmjs.com/package/vditor-plugin)

[![download](https://img.shields.io/npm/dm/vditor-plugin.svg)](https://www.npmjs.com/package/vditor-plugin)

Vditor plugin helper for Vditor Plugin Development!

[简体中文](./README.zh_CN.md) | [English](./README.md)

## Get Started

### For Plugin Developer

If you are just working for Vditor plugin development, just focus on the API below:

```ts

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](#CompatibleType)             | Compatible version of Vditor                                  |

| renderers  |    ×     | `Map` | Custom Vditor renderers                                       |

| styles     |    ×     | `Map` (id, url)               | Custom Vditor Stylesheets                                     |

#### CompatibleType

- "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:

```ts

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 Vditor

- `checkVditorPluginIdentifier(identifier: string)`: Check if the identifier of the plugin is valid

## License

[MIT](./LICENSE)