Obsidian — Custom Plugins Part 2

Andrew Molloy
2 min readDec 26, 2021

--

If you want to build plugins for Obsidian, you should know a few things; I covered some of the programming and technologies to learn in part 1. Here we’ll go over some of the other things you should know to make plugins.

Obsidian API

An API is an application programming interface. It’s the way you can make programs communicate with each other. Think of it as the universal translator in Star Trek. You can’t change the programming or what’s happening inside an application you didn’t write. But there may be an API the developers made available for the application. You can talk to this API with your application or just with some code to affect the application somehow. It’s an entrance to their house, but you have to follow the house rules.

This isn’t always limited to just making applications, and it’s also how many online automation services and application integrations work. They integrate with other applications by taking advantage of any available APIs.

So with Obsidian, they have an API that allows your plugin to work. In addition to knowing how to create the plugins, you should reference the Obsidian API to understand your limitations and capabilities with interfacing with Obsidian.

The API documentation can be found here.

Note that it is considered in the early alpha stages, so subject to change. Usually, this could be offputting, but since many plugins have been made already, it should be encouraging to go ahead and dive in.

This post was created with Typeshare

--

--

No responses yet