Autogenerate README for polymer element

36 views
Skip to first unread message

Luv Agarwal

unread,
Mar 27, 2016, 12:52:36 PM3/27/16
to Polymer
Hey, Is there any tool by which I can autogenerate a README generated from comments in my-element.html?

Luv Agarwal

unread,
Mar 27, 2016, 1:31:15 PM3/27/16
to Polymer
I see that Polymer is using hydrolysis for generating docs. But there is no proper documentation available which explains how to generate docs in markdown format given an element.

Daniel Freedman

unread,
Mar 28, 2016, 2:26:19 PM3/28/16
to Luv Agarwal, Polymer, Peter Burns
We use a tool called tedium to update our elements: https://github.com/polymerlabs/tedium. It does a lot more than generate the README, such as generating issue templates and enforcing shadow dom testing, but it is not quite ready yet for use outside of Polymer's elements (a lot of things are hardcoded). You could try copying some of the techniques, or maybe Peter has some better suggestions.

On Sun, Mar 27, 2016 at 10:31 AM, Luv Agarwal <luvaga...@gmail.com> wrote:
I see that Polymer is using hydrolysis for generating docs. But there is no proper documentation available which explains how to generate docs in markdown format given an element.

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/781f47bb-64bd-4c0c-a63a-f16712aa83bd%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

Reply all
Reply to author
Forward
0 new messages