Skip to content

pecasha/eagle-plugin-mind-map-format-extension

Repository files navigation

Eagle-Plugin-Mind-Map-Format-Extension

Eagle 思维导图文件格式扩展插件

支持格式

  • .km KityMinder(百度脑图)
  • .xmind Xmind
  • .mm FreeMind
  • .mmap MindManager

开发

安装依赖

pnpm i # npm i

打包编译

pnpm build # npm run build

项目结构

  1. 项目根目录中的文件只是项目开发配置或编译配置。
  2. 所有的插件代码、插件配置、资源文件均在/src/目录中。
  3. 插件核心代码均封装在/src/core/目录中,使用TypeScript语法及ES Module标准进行编写,可以使用NPM依赖包。
  4. 插件业务代码在/src/plugin/目录中(此处的代码文件结构均遵循Eagle官方的开发文档标准,关于Eagle插件官方提供的标准及文件结构,可以查看 Eagle Plugin API ),使用JavaScript语法及CommonJS标准进行编写,不建议在此处引用NPM依赖包,此处的thumbnailviewer代码只对页面DOM视图进行操作,其它任何操作都封装至/src/core/核心代码,通过实例化后调用。
  5. 在编译时会先用Rollup/src/core/中的代码打包为单独的模块,并且合并为一个单独的cjs文件以供/src/plugin/中引用(所以要在/src/core/index.ts中将所有需要给/src/plugin/调用的类或方法导出),之后会使用Gulp/src/plugin/中的插件基本业务代码以及资源文件进行压缩合并,输出至/dist/文件夹中。

调试

  • 将本项目打包编译后,在Eagle中按P键打开插件面板,点击开发者选项-导入本地项目,选择本插件根目录中编译后的dist文件夹路径,在插件列表中将会出现思维导图格式扩展
  • 将对应格式的文件导入到Eagle中,双击打开即可进行直接预览。
  • 如需使用开发工具调试或查看console日志,在Eagle中单击选中需要调试的文件,然后按P键打开插件面板,点击插件列表中的思维导图格式扩展,会在新窗口中出现预览,此时在新窗口中按F12键,即可打开Chrome Dev Tools开发工具。

说明

  • 最终编译输出至/dist/目录中的文件是可供Eagle插件系统本地调试使用的完整文件包。如需发布生成.eagleplugin格式的Eagle 插件包文件,可先按照 [调试] 中的方式将本地插件导入到Eagle中,之后在插件列表中点击思维导图格式扩展右侧的,选择打包插件即可。
  • 关于插件开发或Eagle相关问题,可前往 Eagle 插件开发群 进行交流或反馈。
  • 本插件是基于 KityMinder 制作的,感谢百度FEX团队的开源贡献。

Releases

No releases published

Languages