Obsidian插件安装与开发入门指南
Obsidian插件安装与开发入门指南
Obsidian是一款强大的笔记软件，通过插件可以实现更多功能。本文将介绍如何安装和开发Obsidian插件，帮助你更好地使用这款软件。
插件安装
Obsidian的插件和其他应用程序略有差别，每一个Vault仓库对应了自己的所属插件。关于Vault的概念，对应本地的一个文件夹，为Obsidian中的顶级目录。
插件安装主要有两种方式：
Obsidian内直接安装
前提是你已经可以Git加速正常访问插件市场。
直接下载文件安装
无论你从哪里找到的资源，通常来讲都是GitHub，你只需要下载下来解压缩，然后将此插件目录放到你的Vault仓库下的.obsidian/plugin目录下即可。
Mac通过Command + Shift + .在访达中查看隐藏文件。
插件启动和设置
无论哪种方式安装的插件，最后都需要启用（默认是不启用的）。
左下角第三方插件可进行设置。
插件开发
插件本质是JavaScript，所以进行Obsidian plugin的开发其实就是js语言的使用。官方有很好的指导手册：Obsidian Docs。
插件目录结构
正常插件目录结构如下：
- main.js：核心部分，所有插件功能都在这里实现。
- manifest.json：插件的描述信息，这些信息将在社区插件市场浏览展示用。
- data.json：在设置插件功能后，会自动生成此文件，用于保存用户的设置。
插件调试
Obsidian提供了内置的调试工具，可以很好的支持插件开发调试，通过快捷键Windows用户Win + Shift + I或者Mac用户Command + Shift + I。但也可能是其他的，比如我的Command + Option + I，无论哪种，最通用的是通过View菜单栏查看。
打开后调试窗口如下：
在Console输入app.plugins.plugins['Plugin ID']就可以获取到插件对象了，也就是main.js中定义的变量和函数，其中Plugin ID为定义在manifest.json中的ID。
热更新插件
每次修改main.js要想在console控制台看到效果都需要进行插件的停用和启用（需要程序重新加载文件），可以利用插件hot-reload进行热更新，实现每次修改自动更新插件的目的，关于此插件的安装只能通过GitHub网站下载安装，插件市场无此插件。
此插件有个特别注意的点就是，需要在进行热更新的插件目录添加.hotreload文件。比如我的插件目录为myPlugin,具体存放在MyVault/.obsidian/plugins/myPlugin，那么在myPlugin目录下就需要存在文件.hotreload。
这样每次修改内容都可以即时的在obsidian内置的开发工具中调试查看内容了。
插件推荐
obsidian git
将笔记内容自动同步到远程仓库（github或者gitee）都可以。安装教程参考：# 【Obsidian】【Git】使用gitee同步/保存obsidian笔记
Image Classify Paste
如果你也和我一样想要同步的笔记能够在线查看图片，那么大概率也会存在我这种问题，利用这个插件进行粘贴图片的格式化。
Clear Unused Images
从名字就知道，用来清除没有用到的图片，比如我粘贴一张图片，默认就会保存到/static目录，但是发现图片有问题，于是重新截屏了一张，但是原来的图片并不会删除，也就是无效文件的存在。这个插件会在侧边栏生成一个Ribbon，需要手动点击清除，会弹出清除文件的日志。