Skip to content

Commit

Permalink
chore(doc): generate documentation (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
artentica authored and blex41 committed Jan 14, 2019
1 parent d474fa8 commit 83c035a
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ lib-cov
# Coverage directory used by tools like istanbul
coverage

# Dist folder
dist
# Doc generated
docs

# nyc test coverage
.nyc_output
Expand Down
10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ stages:
- lint
- test
- coverage
- deploy doc site

jobs:
include:
Expand All @@ -24,3 +25,12 @@ jobs:
script: npm run test
- stage: coverage
script: npm run coverage
- stage: deploy doc site
script: npm run build:doc && touch ./docs/.nojekyll
if: type != pull_request
deploy:
- provider: pages
skip-cleanup: true
github-token: $GITHUB_TOKEN
keep-history: true
local-dir: ./docs
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
],
"scripts": {
"build": "webpack --mode=production",
"build:doc": "jsdoc ./src -d docs",
"test": "jest --verbose --coverage",
"lint": "eslint --ext .js --max-warnings=0 ./src",
"format": "eslint ./src --fix",
Expand Down

0 comments on commit 83c035a

Please sign in to comment.