开发obsidian插件入门

本文最后更新于 2024年5月16日。

最近整理笔记的时候想删除笔记中的图片,但是一个一个删除链接太费时间了,搜索一下写没有相关插件。本来想着写个python脚本批量删除,后来一想,用python还得来回复制文本并且不能实时预览效果,如果有插件就好了,既然没有现成的,为什么不自己写一个试试呢,这就下手。

准备

开发obsidian插件需要安装开发环境和开发工具:
nodejs环境
开发工具,我选用vscode作为开发工具

创建

进入一个想要开发插件的文件夹,随意新建一个即可,例如我新建一个obsidian-plugin-dev文件夹。

运行如下命令:

npx create-obsidian-plugin

在命令行的提示下输入插件id(我用的是delete-image-links),插件名称,作者,作者网站,是否存在样式表,插件描述,授权协议就可以创建一个样板插件了。

运行进入插件目录:

cd delete-image-links

打包

运行下面命令打包:

npm run build

安装插件

打包完成后,把dist文件夹下的文件复制到obsidian插件文件夹即可。

<你的obsidian文件夹></obsidian/plugin>/plugin/<你的插件文件夹>

然后在设置中安装这个插件即可使用。
安装详细教程: obsidian安装插件教程(全面)

获取插件

github

obsidian-delete-image-links

网盘

公众号:weiyounmimi
公众号weiyoun(id:weiyounmimi)后台回复“插件”即可获取。

船舰过程

我的命令行记录如下:

(base) PS E:\obsidian-plugin-dev> npx create-obsidian-plugin
√ Enter the plugin id (lowercase, no spaces) ... delete-image-links
√ Enter the plugin name ... Delete Image Links
√ Write a short description of what the plugin does ... delete images in notes
√ Enter your name or username you'd like the plugin to show as the author ... weiyoun
√ Add your website or social media account (optional) ... weiyoun.com
√ Does your plugin include styles? ... no
√ Choose a license (type to filter, ↑ or ↓ to navigate) » MIT License
Creating a new obsidian plugin at ./delete-image-links
Installing plugin dependencies, this may take a little while.

added 194 packages in 3m

To get started developing on your plugin run

  cd delete-image-links
  npm run dev

Please check your LICENSE file to see if any updates are needed

(base) PS E:\obsidian-plugin-dev> cd delete-image-links
(base) PS E:\obsidian-plugin-dev\delete-image-links> npm run build

> delete-image-links@0.0.1 build
> obsidian-plugin build src/main.ts

(base) PS E:\obsidian-plugin-dev\delete-image-links>