Camunda Modeler Plugin - Documentation generator

This plugin facilitates to generate process diagram documentation for Camunda 8 BPMN diagrams.

Development Setup

Use npm, the Node.js package manager to download and install required dependencies:

npm install

To make the Camunda Modeler aware of your plugin you must link the plugin to the Camunda Modeler plugin directory via a symbolic link. Available utilities to do that are mklink /d on Windows and ln -s on MacOS / Linux.

Re-start the app in order to recognize the newly linked plugin.

Building the Plugin

You may spawn the development setup to watch source files and re-build the client plugin on changes:

npm run dev

Given you've setup and linked your plugin as explained above, you should be able to reload the modeler to pick up plugin changes. To do so, open the app's built in development toos via F12. Then, within the development tools press the reload shortcuts CTRL + R or CMD + R to reload the app.

To prepare the plugin for release, executing all necessary steps, run:

npm run all

Additional Resources

• List of existing plugins
• Plugins documentation

Licence

MIT