https://github.com/onsenui/wcdoc
API Document Generator for Web Components
https://github.com/onsenui/wcdoc
Last synced: about 1 year ago
JSON representation
API Document Generator for Web Components
- Host: GitHub
- URL: https://github.com/onsenui/wcdoc
- Owner: OnsenUI
- License: other
- Created: 2016-01-13T09:02:14.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-04-30T17:35:43.000Z (about 9 years ago)
- Last Synced: 2025-05-23T12:45:57.966Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 132 KB
- Stars: 4
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# wcdoc
Simple API Document Generator for Web Components.
## Install
Install with [npm](https://www.npmjs.com/)
```sh
$ npm install wcdoc
```
## Examples
```js
var wcdoc = require('wcdoc');
wcdoc.run({
src: ['src/**/*.js'],
basePath: __dirname
}).then(function(result) {
console.log(result);
});
```
## Running tests
Install locked dev dependencies with [Yarn](https://yarnpkg.com/):
```sh
$ yarn install && yarn test
```