The TinyMCE Plugin Generator is designed to make it quick and easy to get started creating plugins to extend and enhance your rich-text editing experience.
The plugin generator is built with the project scaffolding tool Yeoman. To get started install both
yo (the yeoman command) and the generator with the following command:
npm install --global yo generator-tinymce
Wait for the install to finish.
Start the generator with the following command:
You will then be guided through these questions:
- Plugin name?
The name of the plugin.
- How do you want to write your plugin?
With what technology do you want to write your plugin? ES2015 transpiled with Babel, Typescript or the module system used internally by Tiny called Bolt.
- Use yarn instead of npm?
npmfor a speedier install.
- Skip git repo initialization?
Here you can skip the creation of a new repository for the plugin.
- What’s your name?
- Your email? (optional)
- Your website? (optional)
- Which license do you want to use?
Choose the license for the plugin.
Yeoman installs the needed dependencies, and the project is bootstrapped and ready.
cd into the plugin directory and run the following command to start the auto-reloading development server:
Run the following command as root once you have completed development of the plugin:
npm run build
dist directory will be created with a directory named the same as your plugin containing three files:
plugin.js- unminified plugin bundle
plugin.min.js- minified and uglified plugin bundle
LICENSE- the text file containing your license
Thanks for the feedback!
Can't find what you're looking for? Let us know.