深入理解Yank Note插件开发指南

深入理解Yank Note插件开发指南

yn A highly extensible Markdown editor. Version control, AI completion, mind map, documents encryption, code snippet running, integrated terminal, chart embedding, HTML applets, Reveal.js, plug-in, and macro replacement. 项目地址: https://gitcode.com/gh_mirrors/yn/yn

前言

Yank Note作为一款开源且高度可定制的笔记应用，其核心设计理念是让用户能够根据自己的需求打造专属编辑器。通过完善的插件系统，用户可以自由扩展编辑器的功能，而无需等待官方更新。本文将详细介绍Yank Note插件开发的核心概念和实践方法。

快速入门：开发第一个插件

让我们从一个简单的"Hello World"插件开始，了解插件开发的基本流程：

1. 在Yank Note主目录的plugins文件夹中创建plugin-hello.js文件
2. 编写以下代码：

window.registerPlugin({
    name: 'plugin-hello',
    register: ctx => {
        ctx.statusBar.tapMenus(menus => {
            menus['plugin-hello'] = {
                id: 'plugin-hello',
                position: 'left',
                title: 'HELLO',
                onClick: () => {
                    ctx.ui.useToast().show('info', 'HELLO WORLD!');
                }
            }
        })
    }
});

3. 通过托盘菜单的"开发 > 重载"选项刷新应用

完成上述步骤后，你将在状态栏左侧看到新增的"HELLO"菜单，点击它会显示"HELLO WORLD!"提示。

核心概念解析

钩子(Hook)机制

Yank Note通过钩子机制实现插件与核心系统的交互：

1. 注册钩子：使用ctx.registerHook方法注册处理函数
2. 触发钩子：使用ctx.triggerHook方法触发特定钩子
3. 可中断钩子：带有{ breakable: true }选项的钩子可以被中断

常见的可中断钩子包括：

• 动作执行前后的钩子(ACTION_BEFORE_RUN/ACTION_AFTER_RUN)
• 树节点选择钩子(TREE_NODE_SELECT)
• 视图元素交互钩子(VIEW_ELEMENT_CLICK等)
• 编辑器粘贴图像钩子(EDITOR_PASTE_IMAGE)

动作(Action)系统

动作系统是Yank Note的另一核心机制：

1. 动作中心：通过ctx.action管理所有可用动作
2. 内置动作：系统预定义了多种常用动作
3. 动作执行：可以触发、监听和拦截动作

插件能力详解

Yank Note通过上下文对象ctx提供了丰富的API模块，主要包括：

1. UI组件：提供各种界面元素和交互组件
2. 编辑器控制：操作编辑器内容和行为
3. 文件管理：处理笔记文件的读写操作
4. 状态管理：访问和修改应用状态
5. 工具函数：提供各种实用工具方法

要查看完整的ctx模块列表，可以运行以下代码：

console.log(Object.keys(ctx).join('\n'))

插件分发与共享

开发完成的插件可以通过以下方式分享给其他用户：

1. 将插件文件打包分发
2. 遵循标准的插件格式规范
3. 提供必要的使用说明文档

进阶开发建议

对于更简单的功能需求，可以考虑以下替代方案：

1. 运行代码片段：使用内置的RunCode功能快速测试想法
2. 开发微件(Widget)：通过HTML/CSS/JS创建小型交互组件

示例代码片段：

ctx.ui.useToast().show("info", "HELLOWORLD!")

示例微件：

<button onclick="ctx.ui.useToast().show(`info`, `HELLOWORLD!`)">HELLO</button>

总结

Yank Note的插件系统为用户提供了极大的灵活性，通过掌握钩子机制和动作系统，开发者可以深度定制编辑器的各个方面。无论是简单的功能扩展还是复杂的系统集成，Yank Note的插件架构都能提供强大的支持。

yn A highly extensible Markdown editor. Version control, AI completion, mind map, documents encryption, code snippet running, integrated terminal, chart embedding, HTML applets, Reveal.js, plug-in, and macro replacement. 项目地址: https://gitcode.com/gh_mirrors/yn/yn