Documentation generator.

This commit is contained in:
Paul
2021-07-12 17:13:40 +01:00
parent 9b26937a05
commit 57e8d1711d
5 changed files with 2340 additions and 12 deletions
+3 -3
View File
@@ -1,5 +1,5 @@
node_modules
old_src
dist
.vscode
.env
.env
dist
docs
+1
View File
@@ -0,0 +1 @@
Data-oriented library for interacting with the Revolt API.
+13
View File
@@ -0,0 +1,13 @@
const { task, src } = require('gulp');
const typedoc = require('gulp-typedoc');
task("typedoc", () =>
src(["src/**/*.ts"])
.pipe(typedoc({
out: "./docs",
name: "revolt.js",
readme: "README.md",
version: true,
}))
);
+6 -1
View File
@@ -24,10 +24,14 @@
"@types/ws": "^7.2.1",
"dotenv": "^8.2.0",
"fake-indexeddb": "^3.1.2",
"gulp": "^4.0.2",
"gulp-typedoc": "^3.0.1",
"idb": "^6.1.2",
"in-publish": "^2.0.1",
"jsdoc-babel": "^0.5.0",
"node-fetch": "^2.6.1",
"rimraf": "^3.0.2",
"typedoc": "^0.21.4",
"typescript": "^4.2.3"
},
"scripts": {
@@ -35,7 +39,8 @@
"prepublish": "in-publish && tsc || echo Skipping build.",
"build": "rimraf dist && tsc",
"build:watch": "tsc-watch",
"typecheck": "tsc --noEmit"
"typecheck": "tsc --noEmit",
"docs": "gulp typedoc"
},
"files": [
"README.md",
+2317 -8
View File
File diff suppressed because it is too large Load Diff