Add documentation website with generator
This commit is contained in:
parent
6844ec4444
commit
67fb8a31c8
5 changed files with 3406 additions and 13 deletions
4
.gitignore
vendored
4
.gitignore
vendored
|
@ -103,4 +103,6 @@ dist
|
|||
# TernJS port file
|
||||
.tern-port
|
||||
|
||||
diskcache/
|
||||
diskcache/
|
||||
|
||||
docs/
|
|
@ -1 +1,3 @@
|
|||
index.js
|
||||
docs/
|
||||
gh-pages.js
|
||||
|
|
6
gh-pages.js
Normal file
6
gh-pages.js
Normal file
|
@ -0,0 +1,6 @@
|
|||
const ghpages = require("gh-pages");
|
||||
ghpages.publish("docs/", (err) => {
|
||||
if (err) {
|
||||
console.error(err);
|
||||
}
|
||||
});
|
3398
package-lock.json
generated
3398
package-lock.json
generated
File diff suppressed because it is too large
Load diff
|
@ -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"
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue