css-architecture icon indicating copy to clipboard operation
css-architecture copied to clipboard

Published 20 hours ago • verified publisher icon jareware

MD file for css

Open jrock2004 opened this issue 7 years ago • 1 comments

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?

jrock2004 avatar Nov 08 '16 11:11 jrock2004

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?

jareware avatar Nov 08 '16 19:11 jareware