Is there any documentation ?

[vpusher]

Hello,

I am looking for documentation on hydrolys itself. What kind of tokens it detects? what are the information extracted from the HTML source? ... etc

I am wondering to use Polymer-analyser to document some of my HTML templates which are not web components based but needs to be documented. So, I need to know the expected syntax and the possibilities its offers.

Do you have such a doc ?

[justinfagnani]

@vpusher we've been changing the external API a lot in the past couple of weeks. I'll make sure to document everything very soon, hopefully with nice API docs generated by tsdoc. Sorry for the lack of them now!

[rictic]

If you describe what your HTML looks like and the info you'd like to extract from it we could perhaps let you know what the analyzer would say, or could be easily made to say, about them.

[vpusher]

Let's say I have some thymeleaf templates like this one:

<div xmlns:th="http://www.thymeleaf.org" class="container"
     th:style="'background:' + (${data.containsKey('color')} ? ${data.color} : '#d4d4d4') + ';'">
    <h3 th:utext="${name}"></h3>
    <th:block
            th:each="child: ${children}"
            th:utext="${child.content}">
    </th:block>
</div>

It would be nice if I could add some global description about this template and also mention each expected variable with its name, type and default value. All of this written in the template itself and extracted by hydrolys/polymer-analyzer.

[YvanDaSilva]

@justinfagnani Thanks !

[vpusher]

@justinfagnani any update on this ?

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.