obsidianmd avatar

obsidianmd/obsidian-sample-plugin

4.3k 1.7k 44
TypeScript 0BSD
创建于 5 年前 最后更新 2 周前 +3 stars today

AI 综合评分

59 B 级
代码质量
54
文档质量
61
社区健康
57
项目活跃
64
创新性
52

项目简介

Obsidian社区插件开发模板,提供构建配置和最佳实践。

项目摘要

  1. 【主题】这个项目为 Obsidian 插件开发者提供了一个标准化的起点,省去繁琐的环境搭建,让你专注功能实现。

  2. 【核心分点总结】

    1. 一键启动模板:克隆即可拥有 TypeScript 构建环境,无需从零配置。

    2. 最佳实践内置:遵循 Obsidian 官方推荐的项目结构和代码规范,减少踩坑。

    3. 热更新支持:搭配开发模式,修改代码后自动重载插件,提升迭代速度。

    4. 示例代码丰富:包含常用 API 调用示例,如命令、设置、视图等,快速上手。

  3. 【行动指南】

    1. 当你第一次开发 Obsidian 插件时,直接 fork 此模板,代替手动创建项目。
    2. 克隆后运行 npm install,再用 npm run dev 启动调试,边改边测。
    3. 学习模板中的 main.tssettings.ts,理解插件核心生命周期。
  4. 【金句总述】Obsidian 插件开发的脚手架,让创意从第一行代码开始。

  5. 【故事性收尾】过去你面对空白的 main.ts 不知所措,如今只需 git clone,热更新窗口里实时反馈你的每一个灵感,从构思到发布,一气呵成。

相关项目推荐