generator-obsidian-plugin

Obsidian Plugin Yeoman Generator

Installation

For template generator to be fully working it requires Node.js v18 or higher.

First, install Yeoman and generator-obsidian-plugin using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-obsidian-plugin

Then generate your new project:

mkdir new-plugin-name
cd new-plugin-name
yo obsidian-plugin

Sample output

You can see an sample output of this generator at Sample Plugin Extended.

Features of this template

• Obsidian Extended Typings for internal Obsidian API.
• Code style is forced via ESLint.
• Spell checking is forced via CSpell.
• Code formatting is forced via dprint.
• CLI commands and code helpers from Obsidian Dev Utils.
• Supports svelte components. See example in src/SvelteComponents in the generated project.
• Supports react components. See example in src/ReactComponents in the generated project.
• Supports SASS for CSS pre-processing. See example in src/styles/main.scss in the generated project.

NPM Commands

This template offers several NPM commands to facilitate common development tasks:

See documentation for the full list of such commands and how to extend them for your needs.

The documentation above shows usage examples in the form npx obsidian-dev-utils foo. This template additionally allows to call them via npm run foo.

License

© Michael Naumov