Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

build: check broken links in generated docs #416

Merged
merged 9 commits into from
Jan 15, 2019
Merged

build: check broken links in generated docs #416

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
037db3d
build: check dead links on Kokoro
jkwlui Dec 28, 2018
2e13d19
recursive crawl local links
jkwlui Dec 29, 2018
dd5e44b
Merge branch 'master' into jsdoc-link-checker
jkwlui Jan 7, 2019
135cb6f
add missing namespaces
jkwlui Jan 10, 2019
c5ae8d5
Merge branch 'master' into jsdoc-link-checker
jkwlui Jan 10, 2019
4100cd1
Merge branch 'master' into jsdoc-link-checker
JustinBeckwith Jan 14, 2019
d9b196e
fix @type
jkwlui Jan 15, 2019
443b7a8
fix doc links
jkwlui Jan 15, 2019
71918ee
fix dead links[
jkwlui Jan 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .jsdoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ module.exports = {
opts: {
readme: './README.md',
package: './package.json',
template: './node_modules/ink-docstrap/template',
template: './node_modules/jsdoc-baseline',
recurse: true,
verbose: true,
destination: './docs/'
Expand Down
8 changes: 8 additions & 0 deletions .kokoro/docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,11 @@ cd $(dirname $0)/..
npm install

npm run docs

# Check broken links
BIN=./node_modules/.bin

npm install broken-link-checker
npm install http-server
$BIN/http-server -p 8080 docs/ &
$BIN/blc -r http://localhost:8080
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"eslint-plugin-node": "^8.0.0",
"eslint-plugin-prettier": "^3.0.0",
"gts": "^0.9.0",
"ink-docstrap": "^1.3.2",
"jsdoc-baseline": "git+https://github.com/hegemonic/jsdoc-baseline.git",
"intelli-espower-loader": "^1.0.1",
"jsdoc": "^3.5.5",
"mocha": "^5.0.0",
Expand Down