Plugins

[tmcw]

@beaugunderson points out the need for this: how can a documentation user insert something custom into their doc generation process?

One option is browserify's plugin system that derives a lot of its power from labeled-stream-splicer, a module that lets browserify insert and remove streams configurably.

[mik01aj]

+1 for this. I'd love to be able to produce live examples of my React components (Demobox style).

EDIT: FYI, I'm no longer using documentationjs. Since I'm working on a React-based project, I decided to use react-styleguidist for documentation.

[tmcw]

I think we're coming to the point of having certain types of plugins!

• Inference steps
• Extractors

Are sufficiently modularized to be extracted into plugins.

[tmcw]

Thinking more about this: one sketch of an API could be:

var documentation = require('documentation');
var advancedInferencePlugin = require('advanced-inference-plugin');

var files = documentation.listFiles(['index.js']);
var pipeline = new documentation.pipeline();
pipeline.use(advancedInferencePlugin, { option: true });

var output = pipeline.process(files);

By separating file listing / loading and documentation processing, we could achieve a plugin interface similar to unified, which is the pattern in remark and is similar to interfaces like ware.

[tmcw]

Closing, #1125 is the same.