Read the article about the style guide on WordCamp Europe blog. See the current version of the generated style guide.
The main elements are based on the campsite-2017
Install node.js.
npm install gulp
npm install
You are done.
Use gulp for on–the–fly updates of your code (templates, js, css) and style guide.
This will create a build directory for project assets and a styleguide directory from your KSS documentation in CSS without browser-sync live preview.
Feel free to modify everything in the source directory and keep in mind that styleguide and build directories are rebuilt with each gulp build command.
gulpfile.js
package.json
readme.md
source/
├── assets/ [images, stylesheets]
├── styleguide-template/ [modified KSS template for generating style guides]
├── kss-config.json [style guide configuration]
└── styleguide.md [description of the project and the style guide]
build/ [generated via gulp]
styleguide/ [generated via gulp]
- Uses Bourbon, a lightweight Sass Tool Set
- Uses Modular scale for typography
- Uses Susy for grids
- CSS architecture based on ITCSS (Inverted Triangle CSS) by Harry Roberts Article
More information about style guides.
Articles and tools to start documenting interfaces and build style guides: