Skip to content

Commit a31078f

Browse files
committed
docs: Switch to @reconbot/jsdoc-theme for docs
It looks a little nicer and has a github link. This also upgrades eslint and tweaks the config.
1 parent a1eef11 commit a31078f

39 files changed

+11194
-9327
lines changed

.eslintrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"no-unused-vars": [2, { "vars": "all", "args": "after-used" }],
2323
"no-var": 2,
2424
"no-process-exit": 0,
25-
"node/no-unsupported-features": 2,
25+
"node/no-unsupported-features": [2, {"version" : 4}],
2626
"node/shebang": 0,
2727
"object-curly-spacing": [2, "always"],
2828
"object-shorthand": 2,

.jsdoc.json

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,14 @@
2020
"monospaceLinks": true
2121
},
2222
"opts": {
23-
"template": "node_modules/docdash",
23+
"template": "node_modules/@reconbot/jsdoc-theme",
2424
"encoding": "utf8",
2525
"private": true,
2626
"destination": "./docs/",
2727
"recurse": true,
2828
"_tutorials": "./examples"
2929
},
30-
"docdash": {
31-
"static": true,
32-
"sort": true
30+
"reconbot": {
31+
"github": "https://github.com/node-serialport/node-serialport"
3332
}
3433
}

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ We're not against firmware but we're better than it.
2929

3030
## API Documentation
3131

32-
- [API Docs](https://node-serialport.github.io/parsers/)
32+
- [**API Docs**](https://node-serialport.github.io/node-serialport/)
3333
- [Parsers API Docs](https://node-serialport.github.io/parsers/)
3434

3535
See our [changelog](CHANGELOG.md) for what's new, and our [upgrade guide](UPGRADE_GUIDE.md) for a walk-through on differences between major versions.

0 commit comments

Comments
 (0)