Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MD file for css #9

Open
jrock2004 opened this issue Nov 8, 2016 · 1 comment
Open

MD file for css #9

jrock2004 opened this issue Nov 8, 2016 · 1 comment

Comments

@jrock2004
Copy link

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
Copy link
Owner

jareware commented Nov 8, 2016

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants