TypeScript + Vue 3 + ESbuild 的 Obsidian 插件开发模板

[熊海 (Xionghai Brownbear)]

大家晚上好!

这是一个基于 Vue 的 Obsidian 插件开发模板, 它应该有助于您在 ESbuild 中使用 TypeScript 和 Vue 3 进行开发.

• 仓库: GitHub - RealBigBrownBear/obsidian-vue-sample-plugin.
• 教程: Obsidian Plugin 中文开发文档 - Vue (已更新, 经 @酱豆腐精 审核通过).

该项目使用 TypeScript 进行类型检查和文档构建, 并依赖于最新的 Obsidian 插件 API (obsidian.d.ts).

请注意: Obsidian 插件 API 目前仍处于早期的 alpha 阶段, 因此随时都有可能发生变动!

推荐的 IDE 配置

• vscode - IDE.
• Volar - 可以提供 Vue 3 语法支持的 vscode 插件.

使用此仓库的快速入门指南

• 检查是否有人已经为您想要的东西开发了插件! 可能已经有了一个跟您预期足够相似的现有插件, 您可以和它的开发者进行合作.
• 使用 “Use this template” 按钮将此仓库复制一份 (如果您没有看到这个按钮, 请先登录 GitHub).
• 将您的仓库克隆到本地. 为了方便起见, 您可以将仓库的内容放到 .obsidian/plugins/your-plugin-name 文件夹中.
• 安装 Node.js, 然后运行 npm run chore 或 npm install 安装项目依赖.
• 运行 npm run dev 可以在开发模式下将插件编译为 main.js. 此时修改 src 文件夹中的 TypeScript 或 Vue 3 代码都可以自动热更新到 main.js 中.
• 重新启动 Obsidian 以加载最新版本的插件, 并在 Obsidian 的设置窗口中启用插件.
• 运行 npm run build 可以在发布模式下将插件编译为 main.js.

了解更多

• Obsidian Plugin Developer Docs (作者: marcusolsson).
• Obsidian Plugin 中文开发文档 (译者: luhaifeng666 即本站 @酱豆腐精).

开源协议

• MIT 协议.

大家晚安, 祝好梦~