- Tubelator AI
- >
- Videos
- >
- Science & Technology
- >
- How To Create Your Own Obsidian Plugin - Step By Step
How To Create Your Own Obsidian Plugin - Step By Step
Learn how to extend Obsidian by writing your own plugins with this step-by-step tutorial. Find all the necessary resources and requirements in the GitHub repository linked below. Create custom plugins for enhanced note-taking in Obsidian.
Install Tubelator On Chrome
Video Summary & Chapters
1. Introduction 🌟
Overview of Obsidian and the ability to create plugins
2. Prerequisites and Resources 🔍
List of requirements and resources needed for plugin development
3. Getting Started with Plugin Creation 🛠️
Initiating the process by setting up the plugin repository
4. Installing the Plugin into Vault 💻
Guidance on adding the plugin to the Obsidian Vault
5. Setting Up Plugin Directory 📁
Creating necessary directories for the plugin code
6. Handling Plugin Files 📝
Explanation of important files in the plugin directory
7. Installing Dependencies 📦
Installing required dependencies for the plugin code
8. Compiling TypeScript Code 🔄
Converting TypeScript code to JavaScript for plugin execution
9. Reloading Obsidian 🔄
Reloading Obsidian to activate the newly created plugin
10. Setting up the Plugin Class 🛠️
Creating the main class and exporting it.
11. Extending Obsidian's Functionality 🚀
Enhancing word count feature to include line count.
12. Accessing Active File Content 📄
Retrieving and reading the content of the active file.
13. Avoiding String Issue 🧵
Fixing the issue by printing content to console and reloading the plugin.
14. Listening to Active Leaf Change 🍃
Handling the problem by triggering code on a specific event.
15. Updating Line Count 📝
Implementing a method to count lines in the file and updating the status bar.
16. Real-Time Line Count Update 🔄
Ensuring the line count updates dynamically as content changes.
17. Building Your First Plugin 🛠️
Completing the plugin functionality and testing real-time updates.
18. Improving the Plugin ✨
Making minor improvements like fixing tab opening line count issue.
19. Releasing Your Feature 🚀
Preparing to release the finished plugin feature.
20. Introduction 🌟
Overview of updating and releasing a new version of your Obsidian plugin
21. Updating Manifest.json
Steps to update the manifest.json file for the new plugin version
22. Updating versions.json
Updating the versions.json file with plugin and Obsidian version details
23. Creating GitHub Release 🚀
Creating a GitHub release with the new plugin version as a tag
24. Committing Changes Locally
Committing changes with the new plugin version locally
25. Uploading Changes to GitHub
Uploading the changes to GitHub repository from the local machine
26. Creating a Release on GitHub
Creating a release on GitHub with necessary files attached
27. Publishing to Obsidian Community
Steps to publish your plugin to the Obsidian community list
28. Conclusion & Appreciation 🙏
Summary of creating your own Obsidian plugins and final remarks
Video Transcript
obsidian that the powerful note-taking
app that is based on markdown files and
best of all it's possible to extend
obsidian by writing your own plugins and
today I'm going to show you how you can
build your own obsidian plugin step by
step
everything you need to know for this
video can be found on this GitHub
repository which is the first link in
the description down below so at first
you need a few requirements and that is
of course obsidian itself which I guess
you have already installed if you are
watching this video then you need git
which is a version control system for
your code you also need a GitHub account
so just go to github.com and create your
own account then you will need to
install node.js which is a runtime for
JavaScript code you will also need a
text editor where you can write your
code and I will recommend Visual Studio
code for that and lastly I recommend you
to have some basic typescript knowledge
because that's the language that we are
going to code our plugin in if at some
point in this video you might get stuck
then I highly recommend you to check out
The Unofficial obsidian plugin
development documentation by Marcus
Olsen here you can find the most
important information around developing
an obsidian plugin
foreign
but now we are actually getting started
with creating our own plugin and the
first step in this process is that you
go to the official obsidian sample
plugin and click this use this template
button here and then create a new
Repository
this is where the code of your plugin
will be stored and you have to enter a
name for your plugin in my case I will
just call it obsidian plugin tutorial
GitHub will now basically create a copy
of the official template inside your own
account for the purpose of this tutorial
I'm going to create a new obsidian Vault
