return jsdoc2md.getTemplateData({'files': docs.sections[section], 'no-cache': true}) .then(data => jsdoc2md.render({ 'data': data, 'global-index-format': 'none',
gulp.task('docs', function () { var fs = require('fs'); var output = fs.readFileSync('doc/README.header.md'); output += jsdoc2md.renderSync({files: ['./index.js', './sandbox/*.js']}); output += fs.readFileSync('doc/README.footer.md'); fs.writeFileSync('README.md', output) });
jsdoc2md.render({ files: [__dirname + '/node-snowmix.js', libDir + '*.js'] }) .then(output => { fs.writeFileSync(path.resolve(outputDir, 'api.md'), output) console.log('Done') })
(async ()=>{ let docs = await jsdoc2md.render({ files: 'core/db/dbMongo.js' }); })();
gulp.task('create-api-docs', function () { return jsdoc2md.render({files: 'index.js'}) .then(output => fs.writeFile('docs/API.md', output)) });
async function insertApiDocs() { const apiDocs = await jsdoc2md.render(JSDOC_OPTIONS); const oldContent = fs.readFileSync(FILENAME, 'utf8'); if (!REGEXP.test(oldContent)) { throw new Error(`Can not match ${FILENAME} with regexp: ${REGEXP}`); } const newContent = oldContent.replace(REGEXP, `$1${apiDocs}$3`); if (newContent !== oldContent) { fs.writeFileSync(FILENAME, newContent, 'utf8'); console.log(`Changes written to ${FILENAME}`); } else { console.log(`No changes in ${FILENAME}`); } }
jsdoc2md.getJsdocData({ files, jsdoc: true
gulp.task('docs', () => { /* input and output paths */ const inputFile = 'src/**/*.js' const outputDir = `${__dirname}/docs` /* get template data */ const templateData = jsdoc2md.getTemplateDataSync({ files: inputFile }) /* reduce templateData to an array of class names */ const classNames = templateData.reduce((classNames, identifier) => { if (identifier.kind === 'class') classNames.push(identifier.name) return classNames }, []) /* create a documentation file for each class */ for (const className of classNames) { const template = `{{#class name="${className}"}}{{>docs}}{{/class}}` console.log(`rendering ${className}, template: ${template}`) const output = jsdoc2md.renderSync({ data: templateData, template: template }) fs.writeFileSync(path.resolve(outputDir, `${className}.md`), output) } })
const docPath = path.join(dir, docListJson[docName]) console.log('generate docs for', docName, docPath) const md = await jsdoc2md.render({ files: docPath })
async function insertApiDocs() { const apiDocs = await jsdoc2md.render(JSDOC_OPTIONS); const oldContent = fs.readFileSync(FILENAME, 'utf8'); if (!REGEXP.test(oldContent)) { throw new Error(`Can not match ${FILENAME} with regexp: ${REGEXP}`); } const newContent = oldContent.replace(REGEXP, `$1${apiDocs}$3`); if (newContent !== oldContent) { fs.writeFileSync(FILENAME, newContent, 'utf8'); console.log(`Changes written to ${FILENAME}`); } else { console.log(`No changes in ${FILENAME}`); } }