obsidian-plugin/farcaller_obsidian-clojure-plugin-host
1
0
Fork 0
mirror of https://github.com/farcaller/obsidian-clojure-plugin-host.git synced 2026-07-22 11:10:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
farcaller_obsidian-clojure-.../README.md
Vladimir Pouzanov 91a9c63444 Initial commit
2024-10-06 20:17:53 +00:00

1.3 KiB
Raw Permalink Blame History

Clojure Plugin Host for Obsidian

This plugin allows one to author simple plugins written in Clojure (SCI specifically) directly inside Obsidian.

Usage

As of 0.1, this plugin requires Dataview plugin to be installed. To create a new plugin, add a note like this:

---
tags:
  - clojure-plugin
---
```clojure

(defn on-ribbon
  []
  (let [Notice (.-Notice obsidian/exports)]
    (Notice. "A notice from Clojure!")))

(defn on-load
  [plugin]
  (prn "hello plugin!")
  (let [status-bar-el (.addStatusBarItem plugin)
        rib (.addRibbonIcon plugin "dice" "Sample Plugin" on-ribbon)]
    (.setText status-bar-el "Hello world!")))
```

The note must be tagged with clojure-plugin and must contain a single code block with the clojure code inside. The code must have a form on-load, which will be called upon the plugin initialization.

License

This repository is forked off the Obsidian plugin template, which does not have a license. At the same time, this repository doesn't use any code provided in the aforementioned repository, other than general plugin setup. All the clojure code within is distrubuted under Apache-2.0.