Skip to content

Optimized template for initializing Obsidian API plugins for development.

License

Notifications You must be signed in to change notification settings

iLiftALot/template-plugin

Repository files navigation

Template Plugin

Conveniently initialize a new Obsidian plugin with custom configurations.

Features

  • Globally defined Process.env object which can be used to circumnavigate mobile compatibility issues between the process module and mobile platforms.
    • NOTE: You must create a .env file in the root of your plugin directory.
  • NPM development script specifically for logging within esbuild.config.mjs on build using npm run dev:log.
  • Two Obsidian development packages which define undocumented typings and provide utility functions for the Obsidian API.
  • Utilizes terser for main.js minification to reduce plugin size.
  • Deep merges the plugin settings with deepmerge-ts.
  • See other utilities here.

About

Optimized template for initializing Obsidian API plugins for development.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published