-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathbuildDoc.js
More file actions
65 lines (63 loc) · 2.01 KB
/
buildDoc.js
File metadata and controls
65 lines (63 loc) · 2.01 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
const jsdoc2md = require('jsdoc-to-markdown');
const handlebars = require('handlebars');
const fs = require('fs');
const sections = require('./sections');
const path = require('path');
// Build Markdown file form src JSDoc
jsdoc2md.render({
files: path.join(__dirname, '../src/**/*.js'),
plugin: 'dmd-bitbucket',
})
.then( (mdData) => {
// Copy JSDoc file to docs folder
fs.writeFile(path.join(__dirname, '../docs/API.MD'), mdData, (err) => {
if (err) {
return Promise.reject(err);
}
return Promise.resolve('File Written');
});
})
.then( () => {
// Generate Readme.MD from Template
return sections.getTplPromise();
})
.then( (retArr) => {
const OverviewText = retArr[0];
const InstallationText = retArr[1];
const ApiReferenceText = retArr[2];
const usageText = retArr[3];
const contributionText = retArr[4];
const testText = retArr[5];
const licenseText = retArr[6];
const footerText = retArr[7];
return new Promise( (resolve, reject) => {
fs.readFile(path.join(__dirname, './mainFile.tpl'), (err, mainTpl) => {
if (err) {
reject(err);
} else {
const tpl = handlebars.compile(mainTpl.toString());
const rendered = tpl({
overview: OverviewText,
installation: InstallationText,
reference: ApiReferenceText,
usage: usageText,
contribution: contributionText,
tests: testText,
license: licenseText,
footer: footerText,
});
// Copy generated markdown file to root folder
fs.writeFile(path.join(__dirname, '../README.md'), rendered, (err, done) => {
if (err) {
reject(err);
} else {
resolve('done');
}
});
}
});
});
})
.then( () => {
console.log('Completed Document Generation');
});