mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
ae94af0cd8
The `env` global remains available, since templates and plugins may rely upon it, but it's deprecated as of JSDoc 3.4.0.
26 lines
616 B
JavaScript
26 lines
616 B
JavaScript
/**
|
|
* 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>
|
|
*/
|
|
'use strict';
|
|
|
|
var env = require('jsdoc/env');
|
|
var fs = require('jsdoc/fs');
|
|
var 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);
|
|
var parse = markdown.getParser();
|
|
|
|
this.html = parse(content);
|
|
}
|
|
|
|
module.exports = ReadMe;
|