README
doxie --output
A plugin for doxie.
Output rendered comments.
CLI Usage
doxie --output is a plugin for the command-line tool doxie. Most plugins are designed for dox data. Install all three if you haven’t already:
$ npm install --global dox doxie doxie.output
Pass the option --output to doxie to put it in the plugin pipeline. Most likely you’ll want it listed last. I’m including --drop and --render to show this.
$ dox | doxie --drop @private --render --output
My first function
-----------------
Does awesome things.
### Parameters: ###
none.
### Return value: ###
* {Number} – the awesomeness factor
My second function
-----------------
<!-- … -->
Programmatic usage
doxie.output can be used directly with doxie-core – the backend of doxie. Install both if you haven’t already:
$ npm install doxie-core doxie.output
Call doxie.output without parameters to get the plugin function:
const doxie = require('doxie-core');
const drop = require('doxie.drop');
const render = require('doxie.render');
const output = require('doxie.output');
const myTemplate = ({data}) => /* … */;
const myDoxData = {/* … */};
doxie([
drop({'@private': true}),
render(myTemplate),
output(),
])(myDoxData).output;
//» "\nMy first function\n-----------------\n\nDoes awesome things.\n\n### Par…