Add documentation website with generator

This commit is contained in:
karashiiro 2021-05-27 19:23:29 -07:00
parent 6844ec4444
commit 67fb8a31c8
5 changed files with 3406 additions and 13 deletions

2
.gitignore vendored
View file

@ -104,3 +104,5 @@ dist
.tern-port
diskcache/
docs/

View file

@ -1 +1,3 @@
index.js
docs/
gh-pages.js

6
gh-pages.js Normal file
View file

@ -0,0 +1,6 @@
const ghpages = require("gh-pages");
ghpages.publish("docs/", (err) => {
if (err) {
console.error(err);
}
});

3398
package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -10,7 +10,10 @@
],
"scripts": {
"start": "node index.js",
"dev": "nodemon index.js"
"dev": "nodemon index.js",
"docs:generate": "jsdoc create-card.js -d docs -R readme.md",
"docs:deploy": "npm run docs:generate && node gh-pages.js",
"prepublish": "npm run docs:deploy"
},
"dependencies": {
"cache-manager-fs": "^1.0.8",
@ -19,5 +22,9 @@
"express": "^4.17.1",
"node-fetch": "^2.6.1",
"nodemon": "^2.0.7"
},
"devDependencies": {
"gh-pages": "^3.2.0",
"jsdoc": "^3.6.7"
}
}