Updated docs
Some checks failed
continuous-integration/drone/push Build is failing

This commit is contained in:
Nathan Kellenicki 2021-08-29 20:56:42 -07:00
parent 671c2d21db
commit 60dee2c62d
4 changed files with 1182 additions and 5 deletions

View File

@ -5,7 +5,7 @@ pipeline:
commands: commands:
- apt-get update - apt-get update
- apt-get install -y bluetooth bluez libbluetooth-dev libudev-dev - apt-get install -y bluetooth bluez libbluetooth-dev libudev-dev
- git submodule update --init - git submodule update --init --recursive
- npm install - npm install
build: build:

View File

@ -1,9 +1,15 @@
{ {
"tags": { "tags": {
"allowUnknownTags": true "allowUnknownTags": true,
"dictionaries": ["jsdoc"]
},
"source": {
"include": [ "README.md", "dist/node" ],
"includePattern": ".js$"
}, },
"plugins": ["plugins/markdown"], "plugins": ["plugins/markdown"],
"templates": { "templates": {
"referenceTitle": "node-poweredup Reference",
"logoFile": "", "logoFile": "",
"cleverLinks": false, "cleverLinks": false,
"monospaceLinks": false, "monospaceLinks": false,
@ -24,5 +30,12 @@
"markdown": { "markdown": {
"parser": "gfm", "parser": "gfm",
"hardwrap": true "hardwrap": true
},
"opts": {
"destination": "./docs/",
"encoding": "utf8",
"private": true,
"recurse": true,
"template": "./jsdoc-template/braintree"
} }
} }

1167
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -11,7 +11,7 @@
"build:all": "npm run build:node && npm run build:browser", "build:all": "npm run build:node && npm run build:browser",
"lint": "tslint -c tslint.json \"./src/**/*.ts\"", "lint": "tslint -c tslint.json \"./src/**/*.ts\"",
"build": "npm run lint && npm run build:all", "build": "npm run lint && npm run build:all",
"docs": "jsdoc -d docs -c jsdoc.conf.json -t ./jsdoc-template/braintree -R README.md dist/node/**/*.js", "docs": "jsdoc -c .jsdoc.json",
"all": "npm run build && npm run docs", "all": "npm run build && npm run docs",
"prepublishOnly": "npm run lint && npm run build:node" "prepublishOnly": "npm run lint && npm run build:node"
}, },
@ -28,6 +28,7 @@
"@types/web-bluetooth": "0.0.11", "@types/web-bluetooth": "0.0.11",
"buffer": "^6.0.3", "buffer": "^6.0.3",
"jsdoc": "^3.6.7", "jsdoc": "^3.6.7",
"jsdoc-to-markdown": "^7.0.1",
"ts-loader": "^9.2.5", "ts-loader": "^9.2.5",
"tslint": "^6.1.3", "tslint": "^6.1.3",
"typescript": "^4.4.2", "typescript": "^4.4.2",