Plugin development
Use, develop and distribute Notyra plugins
Notyra 3.1.7+ supports theme, CSS, side-panel, Markdown, CodeMirror, command, toolbar, keymap, settings, note and network extensions.
Use the official plugins
Read the notice in Settings → Plugins, then select each plugin from the registry. Official themes and ToC share the yuma-shin/notyra-plugins repository. Custom themes from the former Notyra-Theme repository are now theme plugins.
| Plugin | Plugin ID | Use |
|---|---|---|
| Table of Contents | notyra-toc | Select in the main window's side panel; click headings to navigate |
| Amber | notyra-theme-amber | Select Amber in Settings → Appearance |
| Blue | notyra-theme-blue | Select Blue in Settings → Appearance |
| Emerald | notyra-theme-emerald | Select Emerald in Settings → Appearance |
| Rose | notyra-theme-rose | Select Rose in Settings → Appearance |
No plugin requests permissions. Themes include light/dark palettes; Gray and Purple remain built in. ToC uses active-note events and supports depth, H1 and line-number settings. Currently only the main window displays the side panel.
Registry installation requires published registry data and a latest GitHub Release. Each plugin selects its own <Plugin ID>.zip from that Release. Entering only the repository name installs the default ToC package; choose themes from the registry. Your host build must support collection releases.
Start developing
- Quickstart: template, build and Developer Mode
- Manifest: feature/theme declarations and settings
- API reference: extension points and methods
- Permissions and networking: consent, destination checks and errors
- Lifecycle: per-window activation, stopping and cleanup
- Runnable examples: complete example plugin projects
- Distribution and registry: ZIPs, GitHub Releases and submissions
Plugins, the template, documentation and @notyra/plugin-api are maintained in separate repositories. The API package is distributed under npm's @notyra organization. Consumers no longer vendor API copies; before the first npm publication they pin an immutable repository snapshot, then switch to the matching npm version. The app supplies the API, React and CodeMirror at runtime.