-
Notifications
You must be signed in to change notification settings - Fork 2
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
Issue 8 - Styleguide Integration with Webpack #17
Conversation
@caxy/developers I added a whole bunch of tasks on this PR that I need help with if anyone has bandwidth. Otherwise I'll be working through these items the rest of the week slowly. |
3d8897e
to
333a0f5
Compare
…axy/front-end-starter-kit into issue-8/styleguide-integration
@jschroed91 I'm unclear on what the added value is of having essentially one file in a repo ( |
@beckkramer RE: the separate repo for
|
Makes perfect sense, thanks for breaking that down. |
Styleguide config now include additional information about custom options. Project config file has been altered to use an object for styleguide config, and moved further down the file to pull in path settings.
so as an outsider looking in here..... I have been trying to use the kss-webpack-plugin, but i noticed that the styleguide doesn't actually render the styles when running a watch (only when running a build) because the css needed is an actual static file. Should i be using this new plugin instead? |
@mephilip That's a great question - we actually discussed that same issue today for the webpack plugin we wrote for this: https://github.com/caxy/styleguide-webpack-plugin You can try that plugin out for yourself to see if the remedies the issue - the plugin is very similar to the kss-webpack-plugin, but it takes it a little further and injects the assets that were compiled by webpack into the kss-node configuration. Not sure if that will solve your exact issue or not. There's one limitation w/ the plugin that we plan to update in the coming days - right now it only rebuilds the styleguide when webpack recompiles any assets, but if you're passing any assets into kss-node that aren't actually compiled/watched by webpack, then it won't rebuild (pattern markup partials for example). |
@mephilip Also - forgot to mention ... our webpack plugin isn't documented at all at this point - but if you wanted to try it out, you could have a look in this PR for an example of how to use it |
I am actually working on the documentation right now! |
resolves #8
Integrates Caxy's KSS Zaba Template with webpack and kss-node, and by default makes the styleguide available at /styleguide.
Note: Currently using issue-5/webpack as the base branch - but once issue-5/webpack is merged into master, I will update the base branch to be master.
TODOs
Documentation
config/project.config.js
(e.g. enabling/disabling styleguide, etc.)config/styleguide.config.js
src/styleguide/project-assets/README.md
@beckkramer probably best for youkss-caxy-zaba-template
package (https://github.com/caxy/kss-caxy-zaba-template)caxy-styleguide-webpack-plugin
package (https://github.com/caxy/styleguide-webpack-plugin)src/main.js
var __STYLEGUIDE__ = true;
Additional Clean-up
config/styleguide.config.js
intoconfig/project.config.js
. For ex:source
,sass.files
config/project.config.js
- currently hard-coded to/styleguide
inserver/main.js
src/styles/example-colors.scss
into appropriate location based on what we have decided for ourstyles
directory structure @beckkramer