Skip to content
This repository was archived by the owner on Aug 17, 2024. It is now read-only.

Commit ae32df7

Browse files
committed
The doc seems finished
1 parent 3fa200d commit ae32df7

37 files changed

+398
-339
lines changed

README.md

Lines changed: 190 additions & 40 deletions
Large diffs are not rendered by default.

README.pdf

-6.22 KB
Binary file not shown.

doc/doc.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ clean().then(buildHTML).then(buildMD);
77
function clean() {
88
return new Promise((resolve, reject) => {
99
console.log('Cleaning the doc folder.');
10-
exec('rm -rf doc/html-api && rm -rf doc/md-api && mkdir doc/html-api && mkdir doc/md-api && mkdir doc/md-api/modules',
10+
exec('rm -rf doc/html && rm -rf doc/md && mkdir doc/html && mkdir doc/md && mkdir doc/md/modules',
1111
(err, stdout, stderr) => {
1212
if (stderr) {
1313
console.error(stderr);
@@ -23,11 +23,11 @@ function clean() {
2323
function buildHTML() {
2424
return new Promise((resolve) => {
2525
console.log('Building html doc:');
26-
exec('documentation build src/ --github --output doc/html-api --format "html"', (err, stdout, stderr) => {
26+
exec('documentation build src/ --github --output doc/html --format "html"', (err, stdout, stderr) => {
2727
if (stderr) {
2828
console.error(stderr);
2929
} else {
30-
console.log('src/*.js ---> doc/html-api\n');
30+
console.log('src/*.js ---> doc/html\n');
3131
}
3232
resolve();
3333
});
@@ -38,12 +38,12 @@ function buildMD() {
3838
return new Promise(() => {
3939
console.log('Building markdown doc:');
4040
FILES_TO_DOC.forEach(file =>
41-
exec(`documentation build src/${file}.js --github --format 'md' --output doc/md-api/${file}.md`,
41+
exec(`documentation build src/${file}.js --github --format 'md' --output doc/md/${file}.md`,
4242
(err, stdout, stderr) => {
4343
if (stderr) {
4444
console.error(stderr);
4545
} else {
46-
console.log(`src/${file}.js ---> doc/md-api/${file}.md`);
46+
console.log(`src/${file}.js ---> doc/md/${file}.md`);
4747
}
4848
}
4949
)
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)