tadashi-aikawa / carnelian

Obsidianのプラグイン機能を使って、InvisibleなObsidian体験を実現するための機能を提供する宝石。紅玉髄(カーネリアン)。

Carnelian

InvisibleなObsidian体験を実現するための機能を提供する宝石、紅玉髄(カーネリアン)。

プラグインの機構を使って自分だけの最強のObsidianを構築する。

Note

基本的にtadashi-aikawaが利用する機能を実装しています。ただ、全体の仕組みとlib配下のメソッドは流用できるので、どなたでも利用できます。

開発の前提環境

• Ubuntu (macOSでも動きそう)
• Bun v1.1.20
• Hot Reloadプラグイン

開発環境構築

依存パッケージのインストール

bun i

設定ファイルの作成

carnelianrc.jsonを作成してください。

{
  "vaultPath": "<Vaultのパス>"
}

開発コマンド

bun dev

このコマンドは3つのことを行います。

• Vaultのプラグインディレクトリ(.obsidian/plugins)配下にcarnelianプロジェクトを生成する
• TypeScriptのファイルに変更があったら、esbuildが自動でビルドしてJavaScriptファイルを生成する
• esbuild.config.mjsのFILESに記載されたファイルに変更があったら、PLUGIN_DIRで指定したディレクトリ配下に自動でコピーする

// FILESのデフォルト (変更は不要なはず)
const FILES = ["main.js", "manifest.json", "styles.css"];

Lint

bun lint

機能追加要望

個人的に必要と感じたものに限り取り入れることがあります。IssueやPull Requestからどうぞ。(受け入れ基準は厳しめです)

※ ロゴ画像はAIで生成されています