learnston/obsidian-plugin-setup

How to create your own Obsidian plugin

🪨 Obsidian Plugin Creation

How to create your own Obsidian plugin

About Obsidian

• Obsidian is a note taking app based on Markdown files
• It's extensible

About this plugin

• Simple plugin, that counts the number of lines of the active file
• The line count will be visible in the status bar

Resources

• Official Obsidian Plugin Template
• Unofficial Obsidian Plugin Developer Docs

Usage

Requirement

• Obsidian
• Git
• GitHub account
• Node.js
• Code Editor (I recommend VSCode)
• Basic TypeScript knowledge

Installation

1. Open terminal
2. cd path/to/your/obsidian/vault/.obsidian/plugins
3. git clone https://github.com/flolu/obsidian-plugin
4. npm install
5. npm run dev
6. In Obsidian, press Ctrl + P and select Reload app without saving
7. In Obsidian, go to settings -> Community plugins -> Enable "Example Plugin"

Commands

• npm i (Install dependencies)
• npm run dev (Install dependencies)

Releasing

• Releasing new releases