Skip to content

The host, or 'JavaScript part' of Magnetite, a system for doing plugins in Rust for Obsidian.md

License

Notifications You must be signed in to change notification settings

elmarsto/magnetite-host

Repository files navigation

Magnetite Host

This is a plugin for Obsidian. It works in conjunction with Magnetite Guest, which in turn works in conjunction with the Magnetite Library.

Magnetite lets you do plugins for Obsidian in pure Rust.

This is the "JavaScript part." It works in conjunction with the Guest, which is the "Rust part". Think of this Host as the tape deck; the Guest is the cassette.

Typically, unless you're releasing a new plugin, you won't need to change much (if anything!) in this repo, but you'll probably find yourself cloning it! ;D

Installation

For development, you can clone the host without modification into your plugins directory, like so:

cd <vault>/.obsidian/plugins/
git clone https://github.com/elmarsto/magnetite-host <your-plugin-name>
cd <your-plugin-name>
git submodule add -f https://github.com/<your-gh-handle>/<your-fork-of-the-magnetite-guest-repo> ./magnetite-guest
git submodule update --init --recursive

If you get around to releasing a plugin with Magnetite, (a) let me know and (b) fork this (Host!) repo, edit the manifest.json, update the submodule to point to your guest, and so forth. I can help with this, if you run into trouble.

This repo based heavily on the Obsidian Sample Plugin

See magnetite-lib for API

About

The host, or 'JavaScript part' of Magnetite, a system for doing plugins in Rust for Obsidian.md

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published