search

jareware / css-architecture

8 simple rules for a robust, scalable CSS architecture
2.59k stars 129 forks source link

MD file for css #9

Open jrock2004 opened 8 years ago

jrock2004 commented 8 years ago

Notice you had for each component a MD file to doc how to use the CSS. Can you give an example of what you put in there?

jareware commented 8 years ago

That's mostly just an example to illustrate how everything related to a single component should be co-located as closely as possible. In that example, the MyComponent.md file would contain the developer documentation on how to use <MyComponent>, what its inputs are, etc. In a regular app this would probably be overkill, but for a library of UI components offered to third parties - for example - it is nice.

Does that answer your question?