Skip to content
This repository has been archived by the owner on Jan 25, 2024. It is now read-only.

Latest commit

 

History

History
21 lines (13 loc) · 997 Bytes

README.md

File metadata and controls

21 lines (13 loc) · 997 Bytes

Magnetite Guest Reference Implementation

This is the reference implementation of a Magnetite Guest.

It works in conjunction with the Magnetite Library and Magnetite Host to construe a system of Rust bindings for Obsidian.md plugin development.

Metaphorically, the Host -- the JavaScript part -- is the tape deck. When you're just starting out, leave it as-is.

This repo is a blank cassette. Fork it and lay down something funcy :D

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-this-repo> ./magnetite-guest
git submodule update --init --recursive

After which you will find this very README.md at, say, ~/my-badass-vault/.obsidian/plugins/my-badass-plugin/magnetite-guest/README.md!