widged / obsidian-plugin-template Goto Github PK

This templates includes a barebone directory structure for an Obsidian Plugin. Bundling is based on Rollup.js.

NOTE: This is not the official template. You can find the official sample plugin here. This is a plugin template I customized with a nicer (for me) directory structure and some additional tool (like featuring automatic releases with Github's Actions).

You can click on the "Use this template" button above.

After you created a new repository, remember to rename the RENAME.github to .github to enable the GitHub's Actions. Then go in .github/workflows/release.yml and change PLUGIN_NAME on line 10.

First, install the dependencies with

npm i

Then, you can compile the plugin with:

npm run build

This will create a main.js file in the project root. That is the entry point of your plugin.