plugin.md

Plugin

A plugin is just a npm package with the following directory structure:

└── lib
    ├── browser.js # optional
    └── node.js # optional

browser.js

browser.js exports a function which takes config and returns an object.

moldule.exports = (config) => {
  return {
    utils: {...},
    converters: [...],
  };
};

config is plugin's config:

// in bisheng.config.js
module.exports = {
  plugins: [ 'pluginName?config1=value1&config2=value2' ],
}

// will get this config object in plugin
{
  config1: value1,
  config2: value2,
}

utils of the returned value will be merged to props.utils, for example:

// in browser.js
{
  utils: {
    say(sth) {
      alert(sth);
    },
  },
}

// in template
props.utils.say('Hello world!');

converters will concat other plugins' converters, and then pass to jsonml-to-react-component(which is used by props.utils.toReactComponent).

node.js

node.js exports a function which take markdownData and config, and then return a new markdownData.

module.exports = (markdownData, config) => {
  // do something...
  return markdownData;
};

markdownData is the returned value of mark-twain.

config is the same as browser.js's config.

In node.js, you can add or remove or modify fields in markdownData, and the final Markdown data which will be pass to template had been processed by all the plugins.

Note: we cannot add function to markdownData directly, for markdownData will be JSON.stringify to write to file. However, bisheng has extended the behaviour of stringify, so we can insert code into markdownData by the following syntax:

markdownData.method = {
  __BISHENG_EMBEDED_CODE: true,
  code: 'function(message) { console.log(message) }',
};

Then, the stringified markdownData will be:

{
  method: function(message) { console.log(message) },
  ...
}