search

PolymerElements / iron-component-page

A reusable landing page for elements
36 stars 32 forks source link

Double hyphens are invalid HTML comments #116

Open shannonmoeller opened 7 years ago

shannonmoeller commented 7 years ago

Double hyphens are disallowed in HTML/XML comments. Therefore, the recommended format for documenting element styles is invalid markup:

<!--

...

### Styling

`<paper-button>` provides the following custom properties and mixins
for styling:

Custom property | Description | Default
----------------|-------------|----------
`--paper-button-ink-color` | Background color of the ripple | Based on the button's color
`--paper-button` | Mixin applied to the button | `{}`

...

-->

Expected outcome

There should be a way of documenting dom-module styles using valid code.

Actual outcome

It's possible to move the documentation into the Githubissues.

  • Githubissues is a development platform for aggregating issues.