https://github.com/iliftalot/template-plugin

Optimized template for initializing Obsidian API plugins for development.
https://github.com/iliftalot/template-plugin

obsidian obsidian-md obsidian-plugin obsidian-tem

Last synced: about 1 month ago
JSON representation

Optimized template for initializing Obsidian API plugins for development.

• Host: GitHub
• URL: https://github.com/iliftalot/template-plugin
• Owner: iLiftALot
• Created: 2024-11-11T07:31:33.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-11-12T19:55:27.000Z (about 1 month ago)
• Last Synced: 2024-11-12T20:29:11.883Z (about 1 month ago)
• Topics: obsidian, obsidian-md, obsidian-plugin, obsidian-tem
• Language: JavaScript
• Homepage:
• Size: 74.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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.

  - [obsidian-typings](https://github.com/Fevol/obsidian-typings).

  - [obsidian-dev-utils](https://github.com/RyotaUshio/obsidian-dev-utils/).

- Utilizes [terser](https://github.com/terser/terser) for main.js minification to reduce plugin size.

- Deep merges the plugin settings with [deepmerge-ts](https://github.com/RebeccaStevens/deepmerge-ts).

- See other utilities [here](https://github.com/iLiftALot/template-plugin/tree/main/typings).