A simple styleguide starter kit built with Hologram.
*I recommend installing node via nvm. Node 6.3.0 is used for the development of this project.
git clone https://github.com/bellizio/styleguide-starter-kit.git
cd styleguide-starter-kit
npm install
The styleguide can be used as a standalone application or incorporated into your application itself. The primary goal of this styleguide is to source your application's css directly, so incorporating it into your front-end app is ideal.
All css is written using sass, with the Bourbon library being the only external dependency. normalize.css has been parted out into separate files in the css/base
folder. App css is included in app.scss
. Styleguide-specific css that you do not want included with your app css should go in styleguide.scss
- consider it a theme file for the styleguide. I think the rest should be pretty straightforward and self-explanatory.
There are several gulp tasks defined that generate the styleguide. The build process is minimal and css-specific, but it is flexible so that other assets (js, fonts, images) can be included in the pipeline as well. Check out the Gulp Starter Kit for a complete example.
All files necessary for Hologram to do its thing are in the styleguide
folder. For more details about configuration, check out Hologram's readme.
Run gulp serve
to view and work with the app locally.
See an issue or an opportunity to help make the app better?
After cloning the repo, feel free to reach out by creating a new issue or opening a pull request.