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.

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

LitElement conversion part 4: API docs #136

Closed
web-padawan opened this issue Mar 12, 2020 · 1 comment
Closed

LitElement conversion part 4: API docs #136

web-padawan opened this issue Mar 12, 2020 · 1 comment
Assignees
Labels
next LitElement based version issue

Comments

@web-padawan
Copy link
Member

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 attributes

    • Use @csspart JSDoc annotation for documenting Shadow Parts

    • Use @slot JSDoc annotation for documenting slots

    • Use @event JSDoc annotation for documenting events

  • Add JSDoc comments for all the public properties

Serve docs

  • Copy index.html file from skeleton, update title

  • Update files to analyze in npm run analyze script

  • Start es-dev-server to browse API docs and demo:

$ npm start

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
@web-padawan web-padawan added the next LitElement based version issue label Mar 12, 2020
@web-padawan web-padawan self-assigned this Mar 26, 2020
@web-padawan
Copy link
Member Author

Done by #141

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next LitElement based version issue
Projects
None yet
Development

No branches or pull requests

1 participant