アドオンの作成
最初に 📖 テーマとアドオン と 📖 テーマを作る を読んでください。
各スライドプロジェクトは 1 つのテーマのみを持つことができますが、複数のアドオンを持つことができます。
機能
理論的には、テーマのすべての機能はアドオンで実行できます。ただし、アドオンは Slidev の機能を拡張するプラグインのようなものです。
アドオンで以下のポイントの 1 つ以上を実装することをお勧めします:
- カスタムコンポーネントを提供する
- _新しい_レイアウトを提供する
- 新しいコードスニペットを提供する
- 新しいコードランナーを提供する
- UnoCSS、Vite などのツールを構成する
ただし、以下のポイントはアドオンで実装することは推奨されず、テーマとして実装 する方が良いかもしれません:
- ワイルドカードグローバルスタイル
- 既存のレイアウトをオーバーライドする
- 設定をオーバーライドする
- テーマや他のアドオンと互換性がないその他の事項
アドオンはまた、テーマと同じ方法で必要な Slidev バージョンを指定できます。
プレビュー
テーマと同じように、./slides.md を通じてアドオンをプレビューできます:
md
---
addons:
- ./
---公開
アドオンを公開する場合、.vue や .ts ファイルなどの非 JS ファイルはコンパイルせずに直接公開できます。Slidev はアドオンを使用するときに自動的にコンパイルします。
アドオンは以下の規約に従う必要があります:
- パッケージ名は
slidev-addon-で始まるべきです。たとえば、slidev-addon-nameまたは@scope/slidev-addon-name package.jsonのkeywordsフィールドに"slidev-addon"と"slidev"を追加します
アドオン は NPM に公開せずにローカルで使用できます。アドオンが個人的な使用のためのみの場合、単にそれをローカルアドオンとして使用するか、プライベートスコープ付きパッケージとして公開できます。ただし、他のユーザーと共有したい場合は、NPM レジストリに公開することをお勧めします。