lsm/konva
1
0
Fork 0
mirror of https://github.com/konvajs/konva.git synced 2025-04-23 15:44:27 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
89db41693c
konva/jsdoc-master/lib/jsdoc
History
Eric Rowell 8dd503c7bd checking in jsdoc dir so people can generate docs themselves
2014-01-12 00:39:08 -08:00
..
opts checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
src checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
tag checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
tutorial checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
util checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
augment.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
borrow.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
config.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
doclet.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
fs.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
name.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
package.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
path.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
plugins.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
readme.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
schema.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
tag.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
template.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00
tutorial.js checking in jsdoc dir so people can generate docs themselves 2014-01-12 00:39:08 -08:00

readme.js 

/*global env: true */

/**
 * Make the contents of a README file available to include in the output.
 * @module jsdoc/readme
 * @author Michael Mathews <micmath@gmail.com>
 * @author Ben Blank <ben.blank@gmail.com>
 */

var fs = require('jsdoc/fs'),
	markdown = require('jsdoc/util/markdown');

/**
 * @class
 * @classdesc Represents a README file.
 * @param {string} path - The filepath to the README.
 */
function ReadMe(path) {
    var content = fs.readFileSync(path, env.opts.encoding),
        parse = markdown.getParser();
    
    this.html = parse(content);
}

module.exports = ReadMe;