This document guides you through the process of creating a private plugin. The steps for creating a private or public plugin are the same until you're ready to use your plugin in Builder. For a public plugin, you submit a PR to Builder's GitHub repo.
For a private plugin, which this document covers, you host and maintain the plugin yourself.
Anyone on an Enterprise plan can make private plugins. However, if you'd like to go further and use your own branding with your private plugins, you'll need to add White-label Plugins and Embedding to your Enterprise plan.
Contact your Account Executive, email sales@builder.io, or reach out to us through our contact form.
To get the most out of this document, you should:
- Have an Enterprise plan
- Have a plugin you've made that's ready to add to Builder. For more information, see Making a Plugin, a tutorial for a basic plugin.
- Have your plugin code somewhere on GitHub.
- Go to Account Settings.
- Click on the Pencil icon to the right of Plugins to edit your plugins.
- Click the Add Plugin button.
- Add your CDN link for your repo. You can use any CDN to deliver your plugin. This example uses JSDelivr to deliver the plugin with the following format:
https://cdn.jsdelivr.net/gh/{{ github user name}}/{{repo name}}/dist/plugin.system.js?pluginId={{plugin id in code}}Where github username is your GitHub handle, repo name is the name of the repo you just created on GitHub, and plugin id in code is the name you specified in package.json. Leave out the curly braces, {{}}.
5. Click the Save button.
6. When saving is complete, click the Configure button in the notification at the bottom of the screen.
Tip: You can confirm that your plugin is available by pasting your completed JSDelivr URL into a browser address bar. If the contents of System.register(), displays, it is available for Builder to use.
Using and creating plugins opens up countless possibilities. For more info on plugins, check out the following documents:
- Builder.io plugin examples on GitHub
