webcomponents / webcomponents/webcomponents.org

Support minified elements for auto-generated docs

Open
#991 0 comments 1 reaction 0 assignees View on GitHub
Old Site
Dominant language
TypeScript
Stars
385
Forks
80
PR merge metrics
No merged PRs in 30d

Description

Remember chatting with @samuelli about this before, but thought I'd file a more specific issue now that the new analyzer is live.

If you minify elements for prod (and strip comments) then you end up with fairly useless and ugly auto-generated API docs, like this:

screen shot 2017-06-15 at 4 07 00 pm

Would be great to have a way to either a) disable auto-generated docs to use custom references instead (where you can also document custom events, etc) or b) point analyzer to a custom file (ie: src).

I'd favour being able to just disable analyzer, but can see arguments for both approches.

FWIW I've noticed for our elements inherited props aren't showing (https://github.com/webcomponents/webcomponents.org/issues/972 still a problem?)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.