创建插件

YDoc 插件是发布到 npm 的 node 包,本篇教程假定你已经拥有了 npm 和 node 相关的经验。

目录结构

一个基本的插件有如下的文件结构:

  1. ├── ydoc-plugin-demo/
  2. ├── index.js
  3. ├── package.json

index.js

index.js 是插件的入口文件,init、finish、page:before、page 是插件绑定的钩子。每个插件都可以绑定不同的钩子实现各种各样的功能。

  1. module.exports = {
  2. init: function() {
  3. console.log('init');
  4. },
  5. finish: function() {
  6. console.log('end...');
  7. },
  8. 'page:before': function(page) {
  9. console.log('beforePage', page);
  10. },
  11. page: function(page) {
  12. console.log('page', page);
  13. }
  14. }