Made in Builder

Made in Builder

Webinar 👉 Visually Build at Scale with Builder.io & Netlify on 12/1

×

Developers

Product

Use Cases

Pricing

Developers

Resources

Company

Get StartedLogin

Product

Features

Integrations

Talk to an Expert

Pricing

Blog

Home

Resources

Blog

Forum

Github

Login

Signup

×

Visual CMS

Drag-and-drop visual editor and headless CMS for any tech stack

Theme Studio for Shopify

Build and optimize your Shopify-hosted storefront, no coding required

Resources

Blog

Get StartedLogin

Creating a Private Plugin

enterprise plans

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 this feature on to your Enterprise plan.

Contact your Account Executive, email sales@builder.io, or reach out to us through our contact form.

Prerequisites

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.

Adding your plugin in Builder

  1. Go to Account Settings.
  2. Click on the Pencil icon to the right of Plugins to edit your plugins.
  3. Click the Add Plugin button.
  4. 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:

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.

Next Steps

Using and creating plugins opens up countless possibilities. For more info on plugins, check out the following documents:


Need Expert help?

Reach out to us, and we will match you with a Builder expert.

Connect with us

Was this article helpful?