What doc tool do you use for Polymer elements?

Aleks Totic

unread,

Dec 3, 2014, 4:00:17 PM12/3/14

to polym...@googlegroups.com

I want to use a doc tool on my Polymer elements. What does Polymer team use to generate element documentation?

I've not had luck with poking around Polymer/docs,

Aleks

Rob Dodson

unread,

Dec 3, 2014, 5:52:46 PM12/3/14

to Aleks Totic, polymer-dev

We write the docs in the comments for the elements themselves. Then use core-component-pages to slurp the comments in and generate the doc pages you see on most repos

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 polymer-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/6423399e-bf57-48d9-8754-88caa064d1c2%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Aleks Totic

unread,

Dec 16, 2014, 1:38:47 PM12/16/14

to polym...@googlegroups.com, ato...@gmail.com

That is way cool, turtles all the way down.

I wanted docs like Polymer has for the site I am doing. I have a growing collection of 20+ components, and I am starting to get dizzy remembering what they all do.

I wrote a documentation viewer component:

http://atotic.github.io/fancy-doc-viewer/components/fancy-doc-viewer/

http://atotic.github.io/fancy-doc-viewer/components/fancy-doc-viewer/demo.html

Create a page on your site with fancy-doc-viewer, give it a list of all the pages you'd like documented, and this is what you get.

Cheers,

Aleks

Rob Dodson

unread,

Dec 29, 2014, 9:50:56 PM12/29/14

to Aleks Totic, polymer-dev

hah that's awesome :D I think if you register it with `bower register` it'll show up on customelements.io and component.kitchen. Both those sites look for the `web-components` keyword in your bower.json

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 polymer-dev...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/38e73357-a812-4dc7-b625-ac4984dc1c20%40googlegroups.com.

Arthur Evans

unread,

Dec 30, 2014, 4:27:50 PM12/30/14

to Aleks Totic, polymer-dev

Nice! I like the TOC.

On Tue, Dec 16, 2014 at 10:38 AM, Aleks Totic <ato...@gmail.com> wrote:

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 polymer-dev...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/polymer-dev/38e73357-a812-4dc7-b625-ac4984dc1c20%40googlegroups.com.

Reply all

Reply to author

Forward