obsidian-plugin/ericaxu_gemmy
1
0
Fork 0
mirror of https://github.com/ericaxu/gemmy.git synced 2026-07-22 07:30:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
ericaxu_gemmy/docs
History
Sigrunixia 1416be35e9
✨ Add documentation
2023-09-29 11:42:40 -05:00
..
Adding-animation-to-plugin-details.md ✨ Add documentation 2023-09-29 11:42:40 -05:00
Adding-animation-to-plugin-source.md Rearranged animations plugin guide 2023-09-29 10:45:04 -05:00
Adding-animations-to-Granite.md Add Documentation 2023-09-29 09:54:52 -05:00
Adding-quotes-to-Granite.md ✨ Add documentation 2023-09-29 11:42:40 -05:00
README.md Add Documentation 2023-09-29 09:54:52 -05:00

README.md

Developing Granite plugin

These documents go over the more advanced features of adding to and developing Granite.

Guides

  1. Adding quotes to Granite
  2. Adding animations to Granite
  3. Adding animation to plugin source files

Developer environment

Granite is NPM enabled. You can retrieve the packages needed by using npm -i D.

To auto-build the plugin while you are adding changes, you can use the following command in your terminal/IDE of choice: npm run dev.

If you wish to specify a different output file for the built main.js, then add a .env file in the root directory of your fork, and add the following to the file:

OUTDIR="/absolute/path/to/your/vault/.obsidian/plugins/Granite"

This way, you can reload Obsidian and see your updated changes. You may also utilize the Hot Reload to reload Obsidian for you.