We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
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
Add JSDoc comment for the custom element definition:
Use markdown for a short description. Avoid large snippets
Use @attr JSDoc annotation for documenting state attributes
@attr
Use @csspart JSDoc annotation for documenting Shadow Parts
@csspart
Use @slot JSDoc annotation for documenting slots
@slot
Use @event JSDoc annotation for documenting events
@event
Add JSDoc comments for all the public properties
Copy index.html file from skeleton, update title
index.html
Update files to analyze in npm run analyze script
npm run analyze
Start es-dev-server to browse API docs and demo:
es-dev-server
$ npm start
Copy rollup.config.js from skeleton (used to build CDN demo)
rollup.config.js
Run the npm script to test how the built demo works locally:
$ npm run dist && npm run serve:dist
The text was updated successfully, but these errors were encountered:
Done by #141
Sorry, something went wrong.
web-padawan
No branches or pull requests
Document API
Add JSDoc comment for the custom element definition:
Use markdown for a short description. Avoid large snippets
Use
@attr
JSDoc annotation for documenting state attributesUse
@csspart
JSDoc annotation for documenting Shadow PartsUse
@slot
JSDoc annotation for documenting slotsUse
@event
JSDoc annotation for documenting eventsAdd JSDoc comments for all the public properties
Serve docs
Copy
index.html
file from skeleton, update titleUpdate files to analyze in
npm run analyze
scriptStart
es-dev-server
to browse API docs and demo:Create dist
Copy
rollup.config.js
from skeleton (used to build CDN demo)Run the npm script to test how the built demo works locally:
$ npm run dist && npm run serve:dist
The text was updated successfully, but these errors were encountered: