- Accessing the Workshop
- Defining a new Brick or Mod
- Brick Metadata Directive
- extensionVersion
- Sharing a brick with your organization
Accessing the Workshop
To access the workshop, click Workshop from the sidebar in the Extension Console:
The Workshop Page list all the bricks and mods you have edit access to:
Defining a new Brick or Mod
To define a new brick, click the "Create New Brick" button:
To start with an example, select an example from the "Load a template" dropdown at the bottom of the YAML editor on the Create New Brick page
To learn the basics of configuration files, see the following resources:
Brick Metadata Directive
The Metadata directive uniquely identifies your brick:
metadata:
# unique id for the brick, will be used in other bricks to reference this brick
id: "@alias/collection/brick-id"
# semantic version: https://semver.org
version: 0.0.1
# friendly name and description
name: LinkedIn Profile Menu Item
# a friendly description
description: Add a menu item to the More... dropdown
# a semantic version range expression
extensionVersion: ">=1.4.0"
extensionVersion
Defines the PixieBrix extension version required to run the brick.
If defined on a mod that's used in a Deployment (see
Sharing a brick with your organization
To share a brick with your organization, you have two options:
- Use your organization's alias in the brick id, e.g.,
@pixiebrix/rest-of-id
- Use your personal account alias and toggle your organization from the sharing tab when editing the brick in the Workshop, e.g.,
@todd/rest-of-id