--- aliases: - "Resources and Guides for Plugin Developers" tags: - seedling - MOC --- # for Plugin Developers This note collects resources and guides for beginner and expert plugin developers for [[Obsidian]]. See also [[for Plugin Developers to Automate Tests|Resources and Guides for Plugin Developers writing Tests]]. ## FAQ - [[How to add your plugin to the community plugin list]] ## Guides - [Obsidian Plugin Developer Docs:](https://marcus.se.net/obsidian-plugin-docs/) - brilliant unofficial guide by [[marcusolsson|Marcus Olsson]] - [[How to get started developing plugins]] - [[How to update your plugins and CSS for live preview]] - [[How to release a new version of your plugin]] - [[Using GitHub actions to create releases for plugins]] ## Community Talks - [[Create Your Own Obsidian Plugin - How To Get Started]] - [[How to create your own Obsidian plugin]] ## Links - [Developers & API at Obsidian Forum](https://forum.obsidian.md/c/developers-api/14) - [How to get started with developing a custom plugin](https://forum.obsidian.md/t/how-to-get-started-with-developing-a-custom-plugin/8157) - [Using GitHub actions to release plugins](https://forum.obsidian.md/t/using-github-actions-to-release-plugins/7877) - [Hot Reload](https://forum.obsidian.md/t/plugin-release-for-developers-hot-reload-the-plugin-s-youre-developing/12185) - [Plugins mini FAQ](https://forum.obsidian.md/t/plugins-mini-faq/7737) - [List of available icons](https://forum.obsidian.md/t/list-of-available-icons-for-component-seticon/16332/4) - [Alpha Plugin List](https://forum.obsidian.md/t/meta-alpha-plugin-list-0-9-7/7736) - [Obsidian at GitHub](https://github.com/obsidianmd) - [Obsidian API](https://github.com/obsidianmd/obsidian-api) - [Obsidian Sample Plugin](https://github.com/obsidianmd/obsidian-sample-plugin) - [obsidian-tools:](https://github.com/obsidian-tools/obsidian-tools) an unofficial collection of tools that helps devs build plugins for obsidian. - [obsidian-rust-plugin:](https://github.com/trashhalo/obsidian-rust-plugin) boilerplate needed to write obsidian plugins in rust! - [obsidian-api-docs:](https://github.com/HEmile/obsidian-api-docs/blob/main/docs/00_Home.md) community-provided documentation of the Obsidian API. - [API class diagram](https://i.joethei.space/obsidian-api.png): structure and relationships between API classes([svg version](https://i.joethei.space/obsidian-api.svg)) - [obsidian-dev-tools:](https://github.com/KjellConnelly/obsidian-dev-tools) allows for a modified console (useful for debugging on mobile), and viewing all Obsidian icons/strings. - [obsidian-daily-notes-interface:](https://github.com/liamcain/obsidian-daily-notes-interface) a collection of utility functions for working with dates and daily notes in Obsidian plugins. - [obsidian-calendar-ui:](https://github.com/liamcain/obsidian-calendar-ui) provides an out-of-the-box calendar view for Obsidian plugins. - [obsidian-plugin-template](https://github.com/THeK3nger/obsidian-plugin-template): a plugin template customized with a nicer directory structure and some additional tool (like featuring automatic releases with Github's Actions). - [obsidian-vault-parser](https://github.com/coffee-cup/obsidian-vault-parser): vault parser for the Obsidian note taking app. - [Liam Cain's Obsidian API FAQ](https://liamca.in/Obsidian/API+FAQ/index) - [obsidian-md at GitHub](https://github.com/topics/obsidian-md) - [What tools and libraries are used in Obsidian?](https://konhi.me/obsidian-stack.html) - Ways to download all of Obsidian's plugin source codes to learn from and search through: - [Repoistories Downloader](https://github.com/konhi/obsidian-repositories-downloader) - [Plugin Downloader](https://github.com/luckman212/obsidian-plugin-downloader) %% Hub footer: Please don't edit anything below this line %% # This note in GitHub <span class="git-footer">[Edit In GitHub](https://github.dev/obsidian-community/obsidian-hub/blob/main/04%20-%20Guides%2C%20Workflows%2C%20%26%20Courses/for%20Plugin%20Developers.md "git-hub-edit-note") | [Copy this note](https://raw.githubusercontent.com/obsidian-community/obsidian-hub/main/04%20-%20Guides%2C%20Workflows%2C%20%26%20Courses/for%20Plugin%20Developers.md "git-hub-copy-note") | [Download this vault](https://github.com/obsidian-community/obsidian-hub/archive/refs/heads/main.zip "git-hub-download-vault") </span>