LogoNotyra Docs
プラグイン

プラグイン開発

Notyra のプラグインを使う・作る・配布するためのガイド

Notyra 3.1.7 以降では、テーマ、CSS、サイドパネル、Markdown、CodeMirror、コマンド、ツールバー、キーバインド、設定、ノート操作、通信をプラグインとして追加できます。

公式プラグインを使う

設定 → プラグイン で注意事項を確認し、レジストリから必要なプラグインを選びます。公式テーマと ToC の配布元は共通の yuma-shin/notyra-plugins です。旧 Notyra-Theme リポジトリのカスタムテーマは、テーマプラグインへ統合しました。

プラグインPlugin ID使い方
目次notyra-tocメインウィンドウのサイドパネルで選択。見出しのクリックで元の行へ移動
Ambernotyra-theme-amber設定 → 外観で Amber を選択
Bluenotyra-theme-blue設定 → 外観で Blue を選択
Emeraldnotyra-theme-emerald設定 → 外観で Emerald を選択
Rosenotyra-theme-rose設定 → 外観で Rose を選択

全プラグインで Permission の要求はありません。テーマはライト・ダーク対応で、Gray・Purple は本体内蔵です。ToC は現在ノートの本文から見出しを表示し、深さ・H1・行番号を設定できます。サイドパネル UI は現在メインウィンドウのみです。

通常のインストールには、レジストリと最新 GitHub Release の公開が必要です。同じ Release の <Plugin ID>.zip を個別に取得します。リポジトリ名だけの直接指定は既定の ToC をインストールするため、テーマはレジストリから選んでください。本体側にも複数 ZIP の選択に対応した版が必要です。

開発の入口

実装・テンプレート・ドキュメントに加え、@notyra/plugin-api も独立したリポジトリで管理し、npm の @notyra organization から配布します。テンプレートと ToC に API のコピーは同梱しません。初回 npm 公開前は独立リポジトリの固定コミットを参照し、公開後は同じ API 版の npm パッケージへ切り替えます。実行時 API・React・CodeMirror はアプリが提供します。