mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-25 14:26:29 +00:00
631c6925d4
* feat(core): Switch to Promises everywhere. Adopt Node v4 ES6 Big changes: * Uses template strings where appropriate * Config and argument parsing is unified and there is no such thing as formatterOptions anymore. All user-passed options go through mergeConfig. * The node API surface changed (again): `buildSync` is removed, building operations return Promises. * Now using Flow for internal type annotations. More changes: * Remove buildSync command * feat(inference): Partially implement object shorthand support * Refs #649 * Use Flow annotations to enforce types * Keep flow but switch to comment syntax * Clarify types * More flow improvements * Turn server into class * LinkerStack becomes class too * Fix comment description type * Run flow on lint * Many more flow fixes * More intense flow refactoring * Simplify inference steps * Update inference tests, flow errors down to 1 * Continue refining types * Fix more flow issues * Use 'use strict' everywhere * Make 'ast' property configurable * Fix many tests * Fix more tests * Fix more tests * Fix augments * Test Markdown meta support * Improve test coverage * Switch back from for of to for for speed
40 lines
1.1 KiB
JavaScript
40 lines
1.1 KiB
JavaScript
|
|
'use strict';
|
|
/* @flow */
|
|
|
|
var path = require('path');
|
|
var mergeConfig = require('../merge_config');
|
|
|
|
/**
|
|
* Formats documentation as HTML.
|
|
*
|
|
* @param comments parsed comments
|
|
* @param {Object} args Options that can customize the output
|
|
* @param {string} [args.theme='default_theme'] Name of a module used for an HTML theme.
|
|
* @returns {Promise<Array<Object>>} Promise with results
|
|
* @name formats.html
|
|
* @public
|
|
* @example
|
|
* var documentation = require('documentation');
|
|
* var streamArray = require('stream-array');
|
|
* var vfs = require('vinyl-fs');
|
|
*
|
|
* documentation.build(['index.js'])
|
|
* .then(documentation.formats.html)
|
|
* .then(output => {
|
|
* streamArray(output).pipe(vfs.dest('./output-directory'));
|
|
* });
|
|
*/
|
|
function html(comments/*: Array<Comment>*/,
|
|
config/*: DocumentationConfig*/) {
|
|
return mergeConfig(config).then(config => {
|
|
var themePath = '../../default_theme/';
|
|
if (config.theme) {
|
|
themePath = path.resolve(process.cwd(), config.theme);
|
|
}
|
|
return require(themePath)(comments, config);
|
|
});
|
|
}
|
|
|
|
module.exports = html;
|