TOC

obsidian插件开发-从搭建项目到编译你的一个obsidian插件

1-准备环境

Git installed on your local machine.
A local development environment for Node.js.

如果只是想本地开发插件，可以不需要 Github,但是上传插件市场需要开放在 GitHub 仓库。

2-使用快速构建工具创建 Obsidian 项目框架

参考：快速创建 Obsidian 插件项目 - 开发讨论 - Obsidian 中文论坛

建议开发插件在非工作的 obsidian 库中，避免误操作导致数据丢失，可以单独创建一个库用于插件开发和测试。

比如在 D:/Project/obsidian-plugin-dev-vault，然后在库的 .obsidian 配置文件夹中的 plugins 文件夹中执行下面的命令。

使用步骤

本地安装全局：npm i -g obsidian-plugin-generator
在当前文件夹下生成项目：opg -i ,回车后依次输入完插件项目配置信息，自动克隆项目到本地。

下载后的文件结构如下

.
└── plugin-folder/
├── .git/
├── .editorconfig
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .npmrc
├── esbuild.config.mjs
├── main.js
├── main.ts
├── manifest.json
├── package-lock.json
├── package.json
├── README.md
├── styles.css
├── tsconfig.json
├── version-bump.mjs
├── versions.json
└── readme.md

核心文件

obsidian-sample-plugin/
├── main.ts          # ts主入口文件
├── mainifest.json   # 插件配置信息文件
├── package.json     # ts包依赖管理文件
├── style.css        # 插件样式文件
├── tsconfig.json    # ts配置文件
├── rollup.config.js #
├── versions.json
└── main.js          # 编译后的js文件

3-创建第一个 Obsidian 插件

1、为了开发插件需要用第三方依赖库，需要执行 npm install 下载 node_moduls 文件夹，其中包含 obsidian API 的文件。

2、执行 npm run dev 命令启动项目，此时会开启热编译模式，同步修改，同时自动编译所涉及的开发插件相关的 .ts 文件为 main. js 文件。其中 main. ts 文件入口文件，表示这是所有程序的入口，main.js 就为出口文件。

3、此时可以打开用于开发测试的库，在插件列表中刷新，然后启用默认创建的插件。

4、默认创建的插件会创建一个侧边栏骰子图标的按钮，点击会弹出信息。如果你可以完成前面的效果，说明 obsidian 插件项目成功创建！后续可以进行自定义插件开发了。