Skip to content

README.md

Latest commit

 

History

History
78 lines (61 loc) · 3.48 KB

README.md

File metadata and controls

78 lines (61 loc) · 3.48 KB
Raw

Example plugins

All example plugins live here with manifest.json and prebuilt plugin.js files:

  • counter and notes: offline playgrounds.
  • shortcut-counter: offline keyboard-shortcut consumer; Command+Shift+G / Control+Shift+G increments through the injected host service. Requires shortcuts.
  • broken-page: intentionally fails when its page renders to exercise error handling.

Try the offline playgrounds

Counter and Notes are ready-to-install, readable API v1 modules that need no build tools or runtime dependencies. They use the host's React instance and page service. Neither makes network requests, writes files, nor reads your account. Plugins generally are trusted unsandboxed code; these examples do not change that trust model.

  1. Open the desktop app → Settings → Plugins → Load from folder.
  2. Choose this examples/plugins folder to see the examples, or choose counter / notes directly for a single result.
  3. Choose Counter playground, then Install plugin. It starts disabled.
  4. Enable it in the plugin list, then open its navigation tab and click the counter.
  5. Return to Settings, load this parent folder again, install and enable Notes playground, then type a scratch note on its page.
  6. Disable either plugin to remove only its tab; Delete removes its installation.

Counter and note state are ephemeral and reset when leaving their page. To try an update, change visible text in counter/plugin.js, load it again, and choose Update plugin. An enabled plugin stays enabled and its replacement can run immediately. Roll back restores the previous installed revision. Source files are copied into the installation snapshot, not watched.

To try Git import after these files are pushed, enter this repository's supported HTTPS/SSH URL and its branch/tag, then select examples/plugins/counter or examples/plugins/notes. Private HTTPS authentication is not provided by this slice; use authenticated SSH with an existing agent and known host when available.

Add discovery metadata and a README

The checked-in manifests are minimal. On a host that supports discovery metadata, you can extend counter/manifest.json like this:

{
  "id": "example.counter",
  "name": "Counter playground",
  "apiVersion": 1,
  "description": "Try a click counter to explore plugin pages.",
  "discovery": {
    "category": "developer-tools-and-integrations",
    "tags": ["Examples", "React"]
  }
}

Choose the category from the recognized Settings categories. The description explains the behavior; tags add useful search terms. These optional fields do not change the runtime API version. Older hosts reject description and discovery, so omit both when targeting them.

You can package counter/README.md beside its manifest and prebuilt module. Settings does not display external plugin READMEs, including this one. Keep the guide in the same short shape used for bundled plugins, for example:

# Counter playground

Explore a plugin page with a simple click counter.

## Getting started

1. Enable the plugin in Settings → Plugins, then open **Counter playground**
   from page navigation.
2. Click the counter button to increment the count.

See plugin README guidance and packaging limits before adding README or branding files to a build.