webcomponents / webcomponents.github.io

WebComponents.org is where community-members document Web Components best practices
http://webcomponents.org
733 stars 126 forks source link

Add article on principles for creating general-purpose components #126

Closed JanMiksovsky closed 10 years ago

JanMiksovsky commented 10 years ago

I wrote these principles for the Basic Web Components project, but they're applicable to anyone creating general-purpose components for a broad audience. These principles are still evolving, but they've reached a point where I think they're worth sharing.

Note: When I build the site and check the formatting of the card on the Articles page, the line spacing looks different than for other articles. In the debugger, it appears that other article cards put the description in a paragraph tag inside a div, but in the card for the new article I'm submitting, the text is directly inside the div (no paragraph tag). It's the paragraph that sets the line-height, which is why the card looks off. However, I can't see any reason why the formatting on this article would be different than others — I started by copying the contents of one of the existing .md files. Please fix or let me know how to fix.

0x-r4bbit commented 10 years ago

Very great write-up! Would love to get this in :)

zenorocha commented 10 years ago

Just started reviewing :)

:octocat: Sent from GH.

zenorocha commented 10 years ago

Thank you, pull request merged!

:octocat: Sent from GH.

zenorocha commented 10 years ago

Hey @JanMiksovsky,

That is a really nice article, just tweet it too ;)

The problem you mentioned was related to the file extension. It should be .html.md instead of .md.

Thanks for submitting!

JanMiksovsky commented 10 years ago

@zenorocha Thanks for the publicity, and for the info about the extension.