Skip to content

Commit

Permalink
misc: update doc command on readme, and .eslintrc to ignore generated…
Browse files Browse the repository at this point in the history
… docs
  • Loading branch information
promet99 committed Jul 1, 2023
1 parent 2832832 commit a12e6e2
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ module.exports = {
'id-length': 'off',
'no-param-reassign': 'off',
},
ignorePatterns: ['!.eslintrc.js', 'test/*.js', 'dist'],
ignorePatterns: ['!.eslintrc.js', 'test/*.js', 'dist', 'docs'],
};
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Run `yarn lint` to run the linter, or run `yarn lint:fix` to run the linter and

### Documentation

The API documentation can be generated with the command `yarn docs`, which saves it in the `./docs` directory. Open the `./docs/index.html` file to browse the documentation.
The API documentation can be generated with the command `yarn build:docs`, which saves it in the `./docs` directory. Open the `./docs/index.html` file to browse the documentation.

### Release & Publishing

Expand Down

0 comments on commit a12e6e2

Please sign in to comment.