You can share PixieBrix content in the public Marketplace so other users can access it. This page discusses the requirements for doing just that.
In addition to the text, here’s a video walk through:
To publish an extension on PixieBrix, it needs to be inside a blueprint. A blueprint can hold one or more extensions along with information about the onboarding options, services, and other data.
There are two ways to put an extension in a blueprint:
- Click the ‘add extension to a blueprint’ button to the right of the ‘add’ button on the left side of the page editor
- Navigate to the Extension Console > Blueprints, Active , and click the extension’s options and choose ‘share’
Either method prompts you to give the blueprint an ID, name, version, and description.
It can be helpful to add a collection to the blueprint, for example setting the blueprint ID to
@username/slack/send-slack-message instead of
@username/send-slack-message, as this can make it easier to sort or search for.
In summary, the blueprint ID will be as follows:
Onboarding options and Services
If you’ve added bricks that require services or API integrations to the blueprint, those services will show up in onboarding automatically.
If you have non-service onboarding options you want to add, you can add them by selecting the blueprint in the page editor and navigating to the ‘blueprint options’ tab.
This tab works similarly to the form bricks, allowing you to add any number of options with a preview to the right. The ‘Label’ field determines what the options is called in onboarding and the ‘Name’ field determines what that option is referred to in the blueprint/extensions. These settings can be referenced using @options.fieldName in your extension.
When you’re ready to publish, go to the blueprints page, click ‘share’ on the blueprint, and toggle on the ‘public’ toggle to make it activatable by anyone.
The activation link at the bottom can be used to share the blueprint with others who will be able to activate it once you’ve made it public.
Once you make an extension public, the PixieBrix team is pinged to finish the process of publishing your blueprint. We’ll reach out with any questions of to confirm once complete.
When updating a published blueprint, it’s best practice to increment the version number both so users know it’s a new version and so that you can check the changes made over time or revert to a previous version. It can also help to make a separate version of the blueprint so you don’t break anything on the version users have currently. Updating is as simple as saving in the page editor or workshop.