SC5 style guide generator

  

Looking for a maintainer

If you would like to maintain the project, contact Varya

Style guide generator is a handy little tool that helps you generate good looking style guides from style sheets
using KSS notation. It can be used as a command line utility, gulp task or Grunt task (needs grunt-gulp) with minimal effort.

Table of contents

- Usage
- Prerequisites
- With Gulp
- With Grunt
- As a command line tool
- Build options
- Documenting syntax
- Defining an Angular directive
- Ignore parts of the style sheet from being processed
- Wrapper markup
- Inserted markup
- Pug (jade) markup
- Designer tool
- Images, fonts and other static assets
- Tips and pointers
- and styles
- Providing additional CSS
- Providing additional JavaScript
- onRendered event
- Adding new section in between
- Demo
- Additional Info
- Articles, blog posts
- Supplementary packages

Usage

You should familiarize yourself with both KSS
and node-kss to get yourself started.

SC5 Style guide provides additions to KSS syntax which you can learn below.

$3

The tool should be installed onto:

- Node 4.2.x
- Node 6.9.x

$3

Install plugin locally:

``bash
npm install sc5-styleguide --save-dev
`

The Gulp plugin contains two functions that requires different set of file streams:

generate(): All unprocessed styles containing the KSS markup and style variables. This will process the KSS markup and collects variable information.

applyStyles(): Pre-processed/compiled style sheets. This will create necessary pseudo styles and create the actual style sheet to be used in the styleguide.

The following code shows complete example how to use styleguide with gulp-sass and with gulp watch.

`js
var gulp = require('gulp');
var styleguide = require('sc5-styleguide');
var sass = require('gulp-sass');
var outputPath = 'output';

gulp.task('styleguide:generate', function() {
return gulp.src('*.scss')
.pipe(styleguide.generate({
title: 'My Styleguide',
server: true,
rootPath: outputPath,
overviewPath: 'README.md'
}))
.pipe(gulp.dest(outputPath));
});

gulp.task('styleguide:applystyles', function() {
return gulp.src('main.scss')
.pipe(sass({
errLogToConsole: true
}))
.pipe(styleguide.applyStyles())
.pipe(gulp.dest(outputPath));
});

gulp.task('watch', ['styleguide'], function() {
// Start watching changes and update styleguide whenever changes are detected
// Styleguide automatically detects existing server instance
gulp.watch(['*.scss'], ['styleguide']);
});

gulp.task('styleguide', ['styleguide:generate', 'styleguide:applystyles']);
`

This approach gives flexibility to use any preprocessor. For example, you can freely replace gulp-sass with gulp-ruby-sass. However, please notice that variable parsing works only for Sass, SCSS and Less files.

If you do not use preprocessor you can directly pipe CSS files to applyStyles().

See Build options section for complete documentation of different options.

$3

For projects using Grunt, install the plugin, Gulp and the grunt-gulp bridge.

`bash
npm install sc5-styleguide gulp grunt-gulp --save-dev
`

Then you are able to use the same gulp task inside you Gruntfile:

`js
var gulp = require('gulp'),
styleguide = require('sc5-styleguide');

grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
gulp: {
'styleguide-generate': function() {
var outputPath = 'output';
return gulp.src([''])
.pipe(styleguide.generate({
title: 'My Styleguide',
server: true,
rootPath: outputPath,
overviewPath: 'README.md'
}))
.pipe(gulp.dest(outputPath));
},
'styleguide-applystyles': function() {
return gulp.src('main.scss')
.pipe(styleguide.applyStyles())
.pipe(gulp.dest('output'));
}
},

watch: {
scss: {
files: '*/.scss',
tasks: ['scss', 'gulp:styleguide-generate', 'gulp:styleguide-applystyles']
}
}
});

grunt.loadNpmTasks('grunt-gulp');

grunt.registerTask('default', ['gulp:styleguide-generate', 'gulp:styleguide-applystyles', 'watch']);
`

When using Grunt, we recommend processing styles in Grunt tasks as you do for your main application and pass
the resultant CSS into styleguide's Gulp tasks.

For more specific documentation see the next section.

$3

This way of usage is not recommended, as it does not help as much with introduction of the styleguide into the day-to-day development process.

Install plugin globally:

`bash
npm install -g sc5-styleguide
`

Styleguide command line tool requires two sets of source files:

--kss-source: Unprocessed files containing the KSS markup and Less/Sass variables

--style-source Pre-processed/compiled style sheets to be used in the styleguide

Example usage:

`bash
styleguide --kss-source "sass/.scss" --style-source "public/.css" --output styleguide --watch --server
`

You need to either specify a single directory or you can specify one or more source directories with one or more --kss-source flags.

`bash
styleguide --kss-source "style/.scss" --style-source "public/.css" --output styleguide --watch --server
`

Other options parameters are defined in the Build options section.

$3

CLI and gulp options accept identically named parameters


title (string, optional)

This string is used as a page title and in the page header


favIcon (string, optional)

This enables to replace the default SC5 favicon. It takes path as a string.


extraHead (array or string, optional)

These HTML elements are injected inside the style guide head tag.


sideNav (boolean, optional, default: false)

Enables side navigation. When this option parameter is enabled, styleguide will switch to side navbar.


showReferenceNumbers (boolean, optional, default: false)

When this option parameter is enabled, style guide will show reference numbers on navigation, headings and designer tool.


includeDefaultStyles (boolean, optional, default: true)

Include/exclude default styles.


showMarkupSection (boolean, optional, default: true)

Show/hide Markup section.


hideSubsectionsOnMainSection (boolean, optional, default: false)

This option enables to prevent loading of subsections.


beforeBody (array or string, optional)

These HTML elements are injected inside the style guide tag, before any other content.


afterBody (array or string, optional)

These HTML elements are injected inside the style guide tag, after any other content.


afterSections (array or string, optional)

These HTML elements are injected inside the style guide .sg-body section, after any other content.


commonClass (string or array of strings, optional)

The provided classes are added to all preview blocks in the generated style guide.
This option is useful if you have some namespace classes that should to be added to every block, but you do not want to add it to every example section's markup.


server (boolean, optional)

Enable built-in web-server. To enable Designer tool the style guide must be served with the built-in web server.
The server also has the ability to refresh changed styles or KSS markup without doing a full page reload.


port (number, optional)

Port of the server. Default is 3000.


disableServerLog (boolean, optional)

Disables embedded server log.


rootPath (string, optional)

Server root path. This must be defined if you run the built-in server via gulp or Grunt task.
Point to the same path as the style guide output folder.

Note: This option is not needed when running styleguide via the CLI.


appRoot (string, optional)

Define the appRoot parameter if you are hosting the style guide from a directory other than the root directory of
the HTTP server. If the style guide is hosted at http://example.com/styleguide the appRoot should be styleguide.

When using the build as a subdirectory of your application, tune your server to resolve all the paths to that subdirectory.
This allows Angular to deal with the routing. However, the static files should be resolved as they are stored.


styleVariables (string, optional)

By default variable definitions are searched from every file passed in gulp.src. styleVariables parameter could be used to filter from which files variables are loaded.


disableEncapsulation (boolean, optional, default: false)

Disable Shadow DOM encapsulation. When this option parameter is enabled, all styles are defined in page head and markup examples are not encapsulated using Shadow DOM.


disableHtml5Mode (boolean, optional, default: false)

Disable HTML5 URL mode. When this option parameter is enabled, style guide will use hash bang URLs instead of HTML5 history API. This is useful when hosting static style guides.


basicAuth (object, optional, default: null)

Protect server with basic HTTP authentication.

`js
basicAuth: {
username: 'username',
password: 'password'
}
`


readOnly (boolean, optional, default: false)

Disable variable saving from web interface.


customColors (string, optional)

Path to file that defines custom UI color overrides using PostCSS variables. See all possible variables here.

Internal styles could be overridden by defining new styles inside the styleguide_custom_styles mixin. This mixin is added to the end of the application style sheet.

You can define your own styles with

`css
@define-mixin styleguide_custom_styles {
/ Define your styles here /
}
`

PostCSS configuration supports mixins, nesting, variables, media queries.


parsers (object, optional)

default:

`js
parsers: {
sass: 'scss',
scss: 'scss',
less: 'less',
postcss: 'postcss'
}
`

Styleguide tries to guess which parser to use when parsing variable information from style sheets. The object key defines the file extension to match and the value refers to the parser name. There are three parsers available: scss, less and postcss.

For example, to parse all .css files using postcss parser, following configuration could be used:

`js
{
css: 'postcss'
}
`


styleguideProcessors (object, optional)

default:

`js
styleguideProcessors: {}
`

Styleguide has several processors that enrich or modify the data. For example the sg-wrapper replacement is done by a processor.
You can add your own processor to enrich the styleguide data with your own content or modifications.
You can also override existing functionality by overwriting the related processor.
Currently these processors exist by default and should not be overwritten unless you know what you are doing:

`js
styleguideProcessors: {
10: replaceSectionReferences,
20: generateSectionWrapperMarkup
}
`

You can define your own processors:

`js
styleguideProcessors: {
11: function(styleguide) {
// this will run after replaceSectionReferences
styleguide.sections[0].description = styleguide.sections[0].description + ' [Description from custom Processor]';
},
30: function(styleguide) {
// this will run after generateSectionWrapperMarkup
}
}
`


filesConfig (array, optional) (Experimental feature)

All HTML markup sections defined in the KSS block is dynamically compiled inside the styleguide thus it is possible to use Angular directive inside the markup. These external directives are lazy loaded in the styleguide Angular application. filesConfig configuration parameter could be used to define lazy loaded files. Files are only required, not copied automatically. You need to make sure that files are copied inside the styleguide output directory when generating the styleguide.

Configuration array containing paths to the dependencies of the hosted application

`js
filesConfig: [
{
"name": "NameOfMainAppModule",
"files": [
"path/to/dependency-file.js",
"path/to/application-file.js",
"path/to/stylesheet.css",
],
"template": "path/to/template-filename.html"
}
]
`

Note: When using templateUrl in directives, the template path is relative to style guide index.html, not the hosted application root.

additionalNgDependencies (array or string, optional)

Some angular libraries (such as angular-material) can't be lazy loaded after bootstrapping.
You can use the additionalNgDependencies property to inject additional angular
dependencies to be bootstrapped by the style guide app.

You can pass either a string (if you only have one dependency to add) or
an array of strings. The string(s) should be the same dependencies you would
pass when bootstrapping dependencies in your own modules.

When using this property, you should also specify an afterBody or extraHead
config in order to make sure the dependencies are loaded by the browser before
they are bootstrapped.

Here's an example showing how to use angular-material:

`js
additionalNgDependencies: ['ngMaterial']
extraHead: '

'
afterBody: '



'
`

Documenting syntax

Document your CSS components with KSS

$3

If your components can be rendered with Angular directives, you can define them in KSS markup and so avoid copy-pasting
in the markup field. This is how you can instruct the style guide to use Angular:

`js
// Test directive
//
// markup:
//

`js
// sg-angular-directive:
// name: NameOfMainAppModule
// template: path/to/template-filename.html
// file: path/to/application-file.js
// file: path/to/dependency-file.js
// file: path/to/stylesheet.css
`

You can also write the same with comma-syntax

`js
// sg-angular-directive:
// name: NameOfMainAppModule
// template: path/to/template-filename.html
// file: path/to/application-file.js, path/to/dependency-file.js, path/to/stylesheet.css
`

$3

You can ignore parts of the CSS or KSS from being processed using the following tags:

`js
// styleguide:ignore:start
Ignored styles
// styleguide:ignore:end
`

$3

Sometimes your component examples need a wrapper. For example:

- you need to show how to use