插件结构

理解 Obsidian 插件的目录与清单，是插件开发的第一步。一个插件本质是「清单 + 入口 + 资源」的组合。

核心要点

manifest 字段

manifest.json 是插件的身份证，必填字段：

{
  "id": "my-plugin",
  "name": "My Plugin",
  "version": "1.0.0",
  "minAppVersion": "1.4.0",
  "description": "插件功能描述",
  "author": "你的名字",
  "authorUrl": "https://github.com/you",
  "isDesktopOnly": false
}

• id 需全局唯一，建议与 GitHub 仓库名一致
• minAppVersion 决定兼容的最低 Obsidian 版本
• isDesktopOnly: true 时移动端商店不显示该插件

目录与文件

my-plugin/
├── manifest.json      # 清单
├── main.js            # 编译后的入口（必须有）
├── styles.css         # 可选样式
├── src/               # TypeScript 源码（不打包进插件）
└── versions.json      # 各版本对应 minAppVersion

入口约定

• main.js 中 export default class MyPlugin extends Plugin，实现 onload() / onunload()
• 构建产物 main.js 必须放在插件根目录，Obsidian 直接加载

相关阅读

• 开发入门分区
• Obsidian API 入门
• 插件开发清单