Obsidian — Custom Plugins Part 5

Overview

Andrew Molloy
2 min readDec 29, 2021

I’ll recap what we’ve gone over so far with getting started with creating your Obsidian plugins. I’ve covered what the plugin architecture means with Obsidian and the technologies and programming used and required to get a basic understanding. There is also the Obsidian API (Application Programming Interface) information itself used to access and manipulate the built-in features of Obsidian.

I also went over samples and examples and how to use them to understand how existing plugins work and so you’re not starting from scratch to begin learning. This is also useful for learning programming and specific programming languages.

I also went over version control and why we should start with Git.

Once you have everything ready, there is a specific Git service you should learn and use, Github.

Github

Github is the most popular Git service online. Microsoft now owns it, and it’s by far the largest repository of open source projects (although if you use it, you can keep projects private too). You don’t need an online service or server even to use Git, but it’s helpful across devices and teams. In this case, if you want to submit your plugin to the community directory, you will need to use Github.

In the official sample plugin available here

Although it might be more beneficial to see a real plugin to begin learning and exploring, the documentation of the sample plugin gives instructions on how to submit your plugin to the Community plugins of Obsidian. You effectively need to make a pull request from the release branch here

This post was created with Typeshare

--

--