There are a bunch of new developments in this area. We're currently fleshing out a common steup to document elements, provide a demo link, landing page, and a .zip download option other than Bower. It's still early, but here's an example if you're interested:
- Github source: https://github.com/polymer/core-ajax - Landing page: http://polymer.github.io/core-ajax/ - Demo: http://polymer.github.io/core-ajax/components/core-ajax/demo.html - Docs (component page): http://polymer.github.io/core-ajax/components/core-ajax/ You'll notice that the source on Github only has the bare essentials for the element. The component page use core-doc-viewer<https://github.com/Polymer/core-doc-viewer> to parse the element file on the fly and render live documentation. Nothing is included with the element itself. The only requirement from authors is annotating their elements with JSdoc comments. I realize this probably leaves you with a ton of questions :) We're hoping to document the workflow in the next week or two. Stay tuned! On Sun, Apr 13, 2014 at 5:57 PM, Benjamin Lupton <[email protected]> wrote: > Not sure if this has been covered yet, but it seems that the suggestion is > to include documentation within my-component/my-component.html with the > actual component definition. This seems strange to me as it would include > the docs with the production component build. For us, we've been using > my-component/index.html to include the documentation and a demo for a > component. This seems like it could work really well, with perhaps a HTML > comment inside my-component/my-component.html indicating for them to visit > my-component/index.html for the docs. > > Thoughts? > > > On Tuesday, 9 April 2013 05:02:19 UTC+10, Eric Bidelman wrote: >> >> Inspired by Mike K's great idea of self documenting custom elements, I've >> written a proposal to formalize the effort. >> We have a great opportunity here to come up with best practices early on. >> >> *Proposal: Self Documenting Custom Elements <http://goo.gl/X5DxO>* >> - prototype <http://goo.gl/0pdSW> - a custom element that uses this >> method. >> - it's <wc-documentation> <http://goo.gl/qzW7P> (best viewed in >> Chrome Canary to get ::distributed()). >> >> [image: Inline image 1] >> >> Things I like about this approach: >> >> - The delivery mechanism is <link rel="import">. >> - Becomes the "view source of custom elements". Click an import's link -> >> get its docs. >> - The docs themselves are custom elements >> - works reasonably well in other modern browsers, especially if the >> toolkit polyfills are included. >> >> Looking for everyone's feedback. >> >> Eric Bidelman >> > Follow Polymer on Google+: plus.google.com/107187849809354688692 > > --- > You received this message because you are subscribed to the Google Groups > "Polymer" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/polymer-dev/ea96c526-68f9-4ff6-acc1-a74b1cae18e1%40googlegroups.com<https://groups.google.com/d/msgid/polymer-dev/ea96c526-68f9-4ff6-acc1-a74b1cae18e1%40googlegroups.com?utm_medium=email&utm_source=footer> > . > For more options, visit https://groups.google.com/d/optout. > Follow Polymer on Google+: plus.google.com/107187849809354688692 --- You received this message because you are subscribed to the Google Groups "Polymer" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/CACGqRCDJdtjUjMQpHwGOmsmK%2BJFFUOWyvVxJbqSOqTbnqJiOiw%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
