Publishing

Publishing a plugin makes it available to every educator in the Internote marketplace. Before a plugin becomes visible to the public it must pass a review by the Internote team, which checks for security, performance, and content quality.

Before You Submit

Work through this checklist before submitting:

• The plugin renders correctly at its declared minimum size
• internote.ready() is called within two seconds of initialisation
• internote.onUnload() cancels all animation loops and cleans up resources
• All network requests to external URLs are declared in "permissions": ["network"]
• All storage usage is declared in "permissions": ["storage"]
• No unhandled errors appear in the browser console during normal operation
• The preview image in the manifest accurately represents the plugin's UI
• The manifest description accurately describes what the plugin does

Submitting

The CLI authenticates using your Internote account. If you have not logged in yet:

npx internote-plugin login

This opens a browser window to complete authentication. Once logged in, your credentials are saved locally and reused for future publishes.

To submit your plugin:

npx internote-plugin publish

The CLI bundles your plugin, uploads it to the staging registry under your account, and opens the submission form in your browser. Fill in:

• Category — the marketplace category that best fits your plugin
• Tags — up to five tags for discoverability
• Changelog — what changed in this version (required for updates, optional for first submission)

All review notifications are sent to the email address registered with your Internote account.

The Review Process

1. Submission    — plugin uploaded to staging; automated scan runs
2. Queued        — team notified; you receive a confirmation email
3. Under Review  — team reads the code and tests the plugin
4. Feedback      — team requests changes via email if needed
5. Approved      — plugin signed and pushed to the live registry
6. Live          — plugin appears in the marketplace

Typical review time is two to five business days for a first submission. Updates to already-approved plugins are usually reviewed faster. For the full review checklist and what the team looks for, see Security & Vetting.

Versioning

Plugin versions use semantic versioning (MAJOR.MINOR.PATCH):

• Increment PATCH for bug fixes and small visual improvements
• Increment MINOR for new optional attributes or backwards-compatible features
• Increment MAJOR for changes that break existing Chalk files — renaming or removing a chalk.attributes key, changing an attribute's type, or removing a previously supported value

Educators can pin to a specific version to protect their internotes from breaking changes. See Chalk Integration for version pinning syntax.

Updating an Approved Plugin

Increment the version in manifest.json, update the changelog, and run npm run publish again. Minor and patch updates receive expedited review. Major version updates go through a full review.

Unpublishing

Contact the Internote team to remove a plugin from the marketplace. Unpublishing breaks every internote that references the plugin. Prefer marking the plugin as deprecated in its description rather than unpublishing — this preserves existing internotes while discouraging new installations.