Skip to content

Commit

Permalink
docs: Switch to @reconbot/jsdoc-theme for docs
Browse files Browse the repository at this point in the history
It looks a little nicer and has a github link. This also upgrades eslint and tweaks the config.
  • Loading branch information
reconbot committed Apr 16, 2018
1 parent a1eef11 commit a31078f
Show file tree
Hide file tree
Showing 39 changed files with 11,194 additions and 9,327 deletions.
2 changes: 1 addition & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"no-unused-vars": [2, { "vars": "all", "args": "after-used" }],
"no-var": 2,
"no-process-exit": 0,
"node/no-unsupported-features": 2,
"node/no-unsupported-features": [2, {"version" : 4}],
"node/shebang": 0,
"object-curly-spacing": [2, "always"],
"object-shorthand": 2,
Expand Down
7 changes: 3 additions & 4 deletions .jsdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,14 @@
"monospaceLinks": true
},
"opts": {
"template": "node_modules/docdash",
"template": "node_modules/@reconbot/jsdoc-theme",
"encoding": "utf8",
"private": true,
"destination": "./docs/",
"recurse": true,
"_tutorials": "./examples"
},
"docdash": {
"static": true,
"sort": true
"reconbot": {
"github": "https://github.com/node-serialport/node-serialport"
}
}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ We're not against firmware but we're better than it.

## API Documentation

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

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.
Expand Down
Loading

0 comments on commit a31078f

Please sign in to comment.