Skip to content

Commit

Permalink
various doc-related fixes (#3790)
Browse files Browse the repository at this point in the history
- ensure `.html` gets hit by prettier
- fix order in which docs are generated; let assetgraph process API docs
- some auto-generated content in `docs/index.md` updated
  • Loading branch information
boneskull authored and juergba committed May 2, 2019
1 parent ef69b73 commit 53f18a1
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
5 changes: 4 additions & 1 deletion .lintstagedrc.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"linters": {
"(bin/*|*.js|**/*.js)": ["eslint --fix", "git add"],
"(*.{json,yml,md}|**/*.{json,yml,md})": ["prettier --write", "git add"]
"(*.{json,yml,md,html}|**/*.{json,yml,md,html})": [
"prettier --write",
"git add"
]
},
"ignore": ["docs/**/*.js", "test/**/*.fixture.js", "package*.json"]
}
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -883,7 +883,7 @@ Test Filters
Positional Arguments
spec One or more files, directories, or globs to test
[array] [default: ["test/"]]
[array] [default: ["test"]]
Other Options
--help, -h Show usage information & exit [boolean]
Expand Down
2 changes: 1 addition & 1 deletion jsdoc.conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"static": false
},
"opts": {
"destination": "docs/_dist/api",
"destination": "docs/_site/api",
"encoding": "utf8",
"recurse": true,
"template": "node_modules/@mocha/docdash",
Expand Down
5 changes: 2 additions & 3 deletions package-scripts.js
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ module.exports = {
docs: {
default: {
script:
'nps docs.prebuild && eleventy && nps docs.postbuild && nps docs.api',
'nps docs.prebuild && nps docs.api && eleventy && nps docs.postbuild',
description: 'Build documentation'
},
prebuild: {
Expand Down Expand Up @@ -299,8 +299,7 @@ module.exports = {
description: 'Watch docs for changes & build'
},
api: {
script:
'nps docs.preprocess.api && jsdoc -c jsdoc.conf.json && cp LICENSE docs/_dist/api',
script: 'nps docs.preprocess.api && jsdoc -c jsdoc.conf.json',
description: 'Build API docs'
}
},
Expand Down

0 comments on commit 53f18a1

Please sign in to comment.