Obsidian Dev Utils is a collection of essential functions and utilities designed to streamline your Obsidian plugin development process. Whether you're building a plugin from scratch or enhancing an existing one, these utilities are here to simplify your workflow.
Obsidian is a powerful knowledge base that works on top of a local folder of plain text Markdown files. It's a tool that lets you take notes and organize them, and it supports a rich plugin ecosystem that allows for extensive customization.
This package is ideal for developers who are building or maintaining plugins for Obsidian. It provides a range of tools to make the development process easier, including automated builds, linting, spellchecking, and more.
There is a Obsidian Plugin Yeoman Generator that sets up a new Obsidian plugin project with a basic structure and some useful scripts from this library.
To install the package, run the following command:
npm install obsidian-dev-utilsThe full documentation — guides plus the complete, searchable API reference generated from the library's TSDoc — is published at mnaoumov.dev/obsidian-dev-utils.
- API reference
- Commands
- Helper Functions
- Styling
- Setting Components
- Modals
- Debugging
- Plugin Helpers
- Demo Vault
- Testing
