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

docs: Add markup and styling documentation #227

Merged
merged 2 commits into from
May 8, 2018
Merged

Conversation

antidecaf
Copy link
Contributor

This commit adds documentation of markup and styling in Less components, in order to ease the reintroduction of visual testing and use of said styles in non-React apps. The documentation follows the syntax of KSS, which generates a styleguide into dist/markup upon running npm run kss:build.

@antidecaf antidecaf requested review from wkillerud and selbekk May 7, 2018 14:40
@coveralls
Copy link

coveralls commented May 7, 2018

Coverage Status

Coverage remained the same at 79.447% when pulling 8f04607 on setup-kss-in-packages into b4703a2 on develop.

@selbekk
Copy link
Contributor

selbekk commented May 8, 2018

Wow!

Great work @antidecaf ! Quick question - could we perhaps link to the inline SVGs instead of inlining them? They are the cause of most of the noise in the docs as of now - but I understand if we need to have them.

@wkillerud
Copy link
Contributor

I'm worried that the duplication of examples between KSS and Styleguidist will end up with them getting out of sync. We don't have breaking changes in the markup that often, so maybe it's not that much of an issue I guess.

I'd love it if Styleguidist could show "View HTML" as well as "View Code", but unfortunately that's not possible (yet). That wouldn't solve the visual regression test problem though...

@antidecaf
Copy link
Contributor Author

@selbekk Yeah, I suppose that's possible. Preferably in an upcoming pr though. This markup represents the output of the corresponding React components, so it might be necessary to make the change in those too?

@wkillerud I agree, the best option would definitely be to stick with only one set of examples. Too bad Styleguidist doesn't output HTML, but let's hope that issue results in a plugin or something.

@antidecaf antidecaf merged commit 48e750c into develop May 8, 2018
@antidecaf antidecaf deleted the setup-kss-in-packages branch May 8, 2018 12:33
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

Successfully merging this pull request may close these issues.

4 participants