root
3bf41bf355
update
|
2 jaren geleden | |
|---|---|---|
| .. | ||
| opts | 2 jaren geleden | |
| src | 2 jaren geleden | |
| tag | 2 jaren geleden | |
| tutorial | 2 jaren geleden | |
| util | 2 jaren geleden | |
| app.js | 2 jaren geleden | |
| augment.js | 2 jaren geleden | |
| borrow.js | 2 jaren geleden | |
| config.js | 2 jaren geleden | |
| doclet.js | 2 jaren geleden | |
| env.js | 2 jaren geleden | |
| fs.js | 2 jaren geleden | |
| name.js | 2 jaren geleden | |
| package.js | 2 jaren geleden | |
| path.js | 2 jaren geleden | |
| plugins.js | 2 jaren geleden | |
| readme.js | 2 jaren geleden | |
| schema.js | 2 jaren geleden | |
| tag.js | 2 jaren geleden | |
| template.js | 2 jaren geleden | |
| tutorial.js | 2 jaren geleden | |
readme.js
/**
* Make the contents of a README file available to include in the output.
* @module jsdoc/readme
*/
const env = require('jsdoc/env');
const fs = require('jsdoc/fs');
const markdown = require('jsdoc/util/markdown');
/**
* Represents a README file.
*/
class ReadMe {
/**
* @param {string} path - The filepath to the README.
*/
constructor(path) {
const content = fs.readFileSync(path, env.opts.encoding);
const parse = markdown.getParser();
this.html = parse(content);
}
}
module.exports = ReadMe;
* Make the contents of a README file available to include in the output.
* @module jsdoc/readme
*/
const env = require('jsdoc/env');
const fs = require('jsdoc/fs');
const markdown = require('jsdoc/util/markdown');
/**
* Represents a README file.
*/
class ReadMe {
/**
* @param {string} path - The filepath to the README.
*/
constructor(path) {
const content = fs.readFileSync(path, env.opts.encoding);
const parse = markdown.getParser();
this.html = parse(content);
}
}
module.exports = ReadMe;