Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.41 KB

README.md

File metadata and controls

50 lines (32 loc) · 1.41 KB

prosemirror-suggestions

A plugin for ProseMirror that helps you add suggestions to your editor.

This package is based on @quartzy/prosemirror-suggestions by Tristan Pemble.

"Suggestions" is a loose concept; while we originally designed this plugin around @mentions or #hash-tags, we hope that it can be adapted to other use cases.

This plugin will not render any UI for you. The goal is to handle triggers, giving you tools to render your own UI elements however you choose.

Installation

npm install --save prosemirror-suggestions

Usage

@TODO

Development

# Run tests
npm run test

# Build distributable
npm run build

# Build and watch for changes
npm run watch

Credits

License

The Apache License, v2.0. Please see License File for more information.