{"_id":"sc5-styleguide","_rev":"163-4dc32bd27a5b6775014d6290547c596f","name":"sc5-styleguide","time":{"modified":"2022-06-26T16:21:12.817Z","created":"2014-10-06T12:31:17.509Z","0.0.1":"2014-10-06T12:31:17.509Z","0.1.0":"2014-10-07T07:59:47.309Z","0.2.0":"2014-10-14T09:04:47.811Z","0.2.1":"2014-10-14T13:34:12.682Z","0.2.2":"2014-10-17T10:26:18.853Z","0.2.3":"2014-10-21T14:11:09.976Z","0.2.4":"2014-10-28T12:46:59.774Z","0.2.5":"2014-11-04T14:10:39.288Z","0.2.6-rc1":"2014-11-14T10:29:24.784Z","0.2.6-rc2":"2014-11-14T11:47:06.003Z","0.2.6-rc3":"2014-11-14T12:34:08.888Z","0.2.6":"2014-11-14T13:52:50.243Z","0.2.7":"2014-11-18T11:51:14.816Z","0.2.8":"2014-11-24T12:33:35.624Z","0.2.9":"2014-11-25T12:49:04.210Z","0.2.10":"2014-11-27T14:43:56.106Z","0.2.11":"2014-12-01T12:45:59.606Z","0.2.12":"2014-12-03T22:05:03.227Z","0.2.13":"2014-12-08T12:35:12.718Z","0.2.14":"2014-12-10T10:28:57.570Z","0.2.15":"2014-12-17T11:03:46.410Z","0.2.16":"2014-12-22T13:17:34.408Z","0.2.17":"2015-01-08T14:07:40.595Z","0.3.0-rc1":"2015-01-12T12:56:12.736Z","0.3.0-rc2":"2015-01-12T13:22:56.202Z","0.2.18":"2015-01-15T13:56:47.618Z","0.2.19":"2015-01-19T11:52:33.902Z","0.3.0":"2015-01-20T09:35:29.736Z","0.3.1":"2015-01-21T14:26:10.989Z","0.3.2":"2015-01-21T16:48:08.898Z","0.3.3":"2015-01-22T11:13:04.081Z","0.3.4":"2015-01-23T08:04:52.602Z","0.3.5":"2015-02-04T11:22:28.193Z","0.3.6":"2015-02-11T10:55:35.024Z","0.3.7":"2015-03-16T11:42:01.711Z","0.3.8":"2015-03-30T12:30:30.218Z","0.3.9":"2015-04-07T10:09:15.842Z","0.3.10":"2015-04-09T11:03:11.367Z","0.3.11":"2015-04-14T11:24:24.396Z","0.3.12":"2015-04-16T07:43:44.023Z","0.3.13":"2015-04-20T11:09:58.974Z","0.3.14":"2015-04-26T08:51:11.685Z","0.3.15":"2015-04-27T12:46:40.122Z","0.3.16":"2015-05-19T10:12:55.348Z","0.3.17":"2015-06-02T07:01:34.567Z","0.3.18":"2015-06-02T12:27:47.849Z","0.3.19":"2015-06-03T12:54:44.828Z","0.3.20":"2015-06-09T08:10:42.073Z","0.3.21":"2015-06-11T08:02:33.955Z","0.3.22":"2015-06-12T06:42:47.560Z","0.3.23":"2015-06-16T14:58:16.267Z","0.3.24":"2015-06-23T07:39:05.761Z","0.3.25":"2015-07-01T18:49:15.715Z","0.3.26":"2015-07-15T12:03:39.726Z","0.3.27":"2015-07-23T12:02:18.012Z","0.3.28":"2015-08-06T10:49:44.928Z","0.3.29":"2015-08-14T08:03:32.041Z","0.3.30":"2015-08-24T09:30:31.566Z","0.3.31":"2015-08-26T16:28:39.129Z","0.3.32":"2015-09-02T11:59:17.996Z","0.3.33":"2015-09-07T11:32:20.622Z","0.3.34":"2015-09-14T11:55:46.321Z","0.3.35":"2015-09-21T11:34:20.897Z","0.3.36":"2015-09-24T16:32:39.829Z","0.3.37":"2015-10-14T10:48:34.787Z","0.3.39":"2015-11-10T14:26:58.010Z","0.3.40":"2015-11-25T11:40:18.692Z","0.3.41":"2015-12-09T13:56:19.872Z","0.3.42":"2016-02-15T13:01:37.684Z","0.3.43":"2016-02-17T12:49:36.941Z","0.3.44":"2016-03-02T13:11:55.354Z","0.3.45":"2016-03-21T16:52:18.826Z","0.3.46":"2016-04-20T08:55:56.470Z","0.3.47":"2016-05-11T07:33:02.412Z","1.0.0":"2016-05-24T12:21:32.128Z","1.1.0":"2016-08-03T10:23:27.705Z","1.1.1":"2016-08-04T11:27:13.004Z","1.1.2":"2016-08-23T13:07:10.004Z","1.1.3":"2016-09-02T11:41:36.050Z","1.2.0":"2016-09-16T09:32:39.105Z","1.3.0":"2016-11-04T13:28:49.660Z","1.3.1":"2016-11-11T12:24:28.307Z","1.3.2":"2016-11-17T13:22:29.999Z","1.3.3":"2016-11-28T14:28:10.407Z","1.4.0":"2016-12-28T09:51:36.848Z","1.4.1":"2017-01-03T11:52:16.147Z","1.5.0":"2017-01-18T11:36:24.571Z","1.6.0":"2017-04-10T12:28:00.162Z","1.7.0":"2017-05-04T12:04:32.690Z","1.8.0":"2017-05-05T09:27:34.864Z","1.8.1":"2017-05-08T11:46:54.764Z","1.9.0":"2017-06-02T12:20:16.376Z","2.0.0":"2017-06-27T12:13:50.080Z","2.0.1":"2017-06-28T10:38:25.761Z","2.0.2":"2017-08-10T06:53:03.903Z","2.0.3":"2017-08-14T15:55:12.726Z","2.0.4":"2017-08-17T16:24:49.002Z","2.2.0":"2018-06-19T12:56:13.674Z"},"maintainers":[{"name":"hannu","email":"hannu@sc5.io"},{"name":"jpbackman","email":"juuso.backman@sc5.io"},{"name":"junaidrsd","email":"junaid@sc5.io"},{"name":"matudelic","email":"matu.eriksson@gmail.com"},{"name":"simkall","email":"simon.kall@gmail.com"},{"name":"varya","email":"mail@varya.me"}],"dist-tags":{"latest":"2.2.0","0.3.rc2":"0.3.0-rc2"},"description":"Styleguide generator is a handy little tool that helps you generate good looking styleguides from stylesheets using KSS notation.","readme":"# SC5 style guide generator\n\n[![Build Status](https://travis-ci.org/SC5/sc5-styleguide.svg?branch=master)](https://travis-ci.org/SC5/sc5-styleguide) [![dependencies](https://david-dm.org/SC5/sc5-styleguide.svg)](https://david-dm.org/SC5/sc5-styleguide) [![npm version](https://badge.fury.io/js/sc5-styleguide.svg)](http://badge.fury.io/js/sc5-styleguide)\n\n## Looking for a maintainer\n\n**If you would like to maintain the project, contact Varya **\n\nStyle guide generator is a handy little tool that helps you generate good looking style guides from style sheets\nusing KSS notation. It can be used as a command line utility, gulp task or Grunt task (needs grunt-gulp) with minimal effort.\n\n## Table of contents\n\n\n\n\n\n- [Usage](#usage)\n - [Prerequisites](#prerequisites)\n - [With Gulp](#with-gulp)\n - [With Grunt](#with-grunt)\n - [As a command line tool](#as-a-command-line-tool)\n - [Build options](#build-options)\n- [Documenting syntax](#documenting-syntax)\n - [Defining an Angular directive](#defining-an-angular-directive)\n - [Ignore parts of the style sheet from being processed](#ignore-parts-of-the-style-sheet-from-being-processed)\n - [Wrapper markup](#wrapper-markup)\n - [Inserted markup](#inserted-markup)\n - [Pug (jade) markup](#pug-jade-markup)\n- [Designer tool](#designer-tool)\n- [Images, fonts and other static assets](#images-fonts-and-other-static-assets)\n- [Tips and pointers](#tips-and-pointers)\n - [`` and `` styles](#html-and-body-styles)\n - [Providing additional CSS](#providing-additional-css)\n - [Providing additional JavaScript](#providing-additional-javascript)\n - [onRendered event](#onrendered-event)\n - [Adding new section in between](#adding-new-section-in-between)\n- [Demo](#demo)\n- [Additional Info](#additional-info)\n - [Articles, blog posts](#articles-blog-posts)\n - [Supplementary packages](#supplementary-packages)\n\n\n\n## Usage\n\nYou should familiarize yourself with both [KSS](https://github.com/kneath/kss)\nand [node-kss](https://github.com/kss-node/kss-node) to get yourself started.\n\nSC5 Style guide provides additions to KSS syntax which you can learn [below](#user-content-documenting-syntax).\n\n### Prerequisites\n\nThe tool should be installed onto:\n\n- Node 4.2.x\n- Node 6.9.x\n\n### With Gulp\n\nInstall plugin locally:\n\n```bash\nnpm install sc5-styleguide --save-dev\n```\n\nThe Gulp plugin contains two functions that requires different set of file streams:\n\n`generate()`: All unprocessed styles containing the KSS markup and style variables. This will process the KSS markup and collects variable information.\n\n`applyStyles()`: Pre-processed/compiled style sheets. This will create necessary pseudo styles and create the actual style sheet to be used in the styleguide.\n\nThe following code shows complete example how to use styleguide with gulp-sass and with gulp watch.\n\n```js\nvar gulp = require('gulp');\nvar styleguide = require('sc5-styleguide');\nvar sass = require('gulp-sass');\nvar outputPath = 'output';\n\ngulp.task('styleguide:generate', function() {\n return gulp.src('*.scss')\n .pipe(styleguide.generate({\n title: 'My Styleguide',\n server: true,\n rootPath: outputPath,\n overviewPath: 'README.md'\n }))\n .pipe(gulp.dest(outputPath));\n});\n\ngulp.task('styleguide:applystyles', function() {\n return gulp.src('main.scss')\n .pipe(sass({\n errLogToConsole: true\n }))\n .pipe(styleguide.applyStyles())\n .pipe(gulp.dest(outputPath));\n});\n\ngulp.task('watch', ['styleguide'], function() {\n // Start watching changes and update styleguide whenever changes are detected\n // Styleguide automatically detects existing server instance\n gulp.watch(['*.scss'], ['styleguide']);\n});\n\ngulp.task('styleguide', ['styleguide:generate', 'styleguide:applystyles']);\n```\n\nThis 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.\n\nIf you do not use preprocessor you can directly pipe CSS files to `applyStyles()`.\n\nSee [Build options](#build-options) section for complete documentation of different options.\n\n### With Grunt\n\nFor projects using Grunt, install the plugin, Gulp and the `grunt-gulp` bridge.\n\n```bash\nnpm install sc5-styleguide gulp grunt-gulp --save-dev\n```\n\nThen you are able to use the same gulp task inside you `Gruntfile`:\n\n```js\nvar gulp = require('gulp'),\n styleguide = require('sc5-styleguide');\n\ngrunt.initConfig({\n pkg: grunt.file.readJSON('package.json'),\n gulp: {\n 'styleguide-generate': function() {\n var outputPath = 'output';\n return gulp.src([''])\n .pipe(styleguide.generate({\n title: 'My Styleguide',\n server: true,\n rootPath: outputPath,\n overviewPath: 'README.md'\n }))\n .pipe(gulp.dest(outputPath));\n },\n 'styleguide-applystyles': function() {\n return gulp.src('main.scss')\n .pipe(styleguide.applyStyles())\n .pipe(gulp.dest('output'));\n }\n },\n\n watch: {\n scss: {\n files: '**/*.scss',\n tasks: ['scss', 'gulp:styleguide-generate', 'gulp:styleguide-applystyles']\n }\n }\n});\n\ngrunt.loadNpmTasks('grunt-gulp');\n\ngrunt.registerTask('default', ['gulp:styleguide-generate', 'gulp:styleguide-applystyles', 'watch']);\n```\n\nWhen using Grunt, we recommend processing styles in Grunt tasks as you do for your main application and pass\nthe resultant CSS into styleguide's Gulp tasks.\n\nFor more specific documentation see the next section.\n\n### As a command line tool\n\nThis 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.\n\nInstall plugin globally:\n\n```bash\nnpm install -g sc5-styleguide\n```\n\nStyleguide command line tool requires two sets of source files:\n\n`--kss-source`: Unprocessed files containing the KSS markup and Less/Sass variables\n\n`--style-source` Pre-processed/compiled style sheets to be used in the styleguide\n\nExample usage:\n\n```bash\nstyleguide --kss-source \"sass/*.scss\" --style-source \"public/*.css\" --output styleguide --watch --server\n```\n\nYou need to either specify a single directory or you can specify one or more source directories with one or more --kss-source flags.\n\n```bash\nstyleguide --kss-source \"style/*.scss\" --style-source \"public/*.css\" --output styleguide --watch --server\n```\n\nOther options parameters are defined in the [Build options](#build-options) section.\n\n### Build options\n\nCLI and gulp options accept identically named parameters\n\n\n**title** (string, optional)\n\nThis string is used as a page title and in the page header\n\n\n**favIcon** (string, optional)\n\nThis enables to replace the default SC5 favicon. It takes path as a string.\n\n\n**extraHead** (array or string, optional)\n\nThese HTML elements are injected inside the style guide `head` tag.\n\n\n**sideNav** (boolean, optional, default: false)\n\nEnables side navigation. When this option parameter is enabled, styleguide will switch to side navbar.\n\n\n**showReferenceNumbers** (boolean, optional, default: false)\n\nWhen this option parameter is enabled, style guide will show reference numbers on navigation, headings and designer tool.\n\n\n**includeDefaultStyles** (boolean, optional, default: true)\n\nInclude/exclude default styles.\n\n\n**showMarkupSection** (boolean, optional, default: true)\n\nShow/hide Markup section.\n\n\n**hideSubsectionsOnMainSection** (boolean, optional, default: false)\n\nThis option enables to prevent loading of subsections.\n\n\n**beforeBody** (array or string, optional)\n\nThese HTML elements are injected inside the style guide `` tag, before any other content.\n\n\n**afterBody** (array or string, optional)\n\nThese HTML elements are injected inside the style guide `` tag, after any other content.\n\n\n**afterSections** (array or string, optional)\n\nThese HTML elements are injected inside the style guide `.sg-body` section, after any other content.\n\n\n**commonClass** (string or array of strings, optional)\n\nThe provided classes are added to all preview blocks in the generated style guide.\nThis 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.\n\n\n**server** (boolean, optional)\n\nEnable built-in web-server. To enable Designer tool the style guide must be served with the built-in web server.\nThe server also has the ability to refresh changed styles or KSS markup without doing a full page reload.\n\n\n**port** (number, optional)\n\nPort of the server. Default is 3000.\n\n\n**disableServerLog** (boolean, optional)\n\nDisables embedded server log.\n\n\n**rootPath** (string, optional)\n\nServer root path. This must be defined if you run the built-in server via gulp or Grunt task.\nPoint to the same path as the style guide output folder.\n\nNote: This option is not needed when running styleguide via the CLI.\n\n\n**appRoot** (string, optional)\n\nDefine the `appRoot` parameter if you are hosting the style guide from a directory other than the root directory of\nthe HTTP server. If the style guide is hosted at `http://example.com/styleguide` the appRoot should be `styleguide`.\n\nWhen using the build as a subdirectory of your application, tune your server to resolve all the paths to that subdirectory.\nThis allows Angular to deal with the routing. However, the static files should be resolved as they are stored.\n\n\n**styleVariables** (string, optional)\n\nBy 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.\n\n\n**disableEncapsulation** (boolean, optional, default: false)\n\nDisable 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.\n\n\n**disableHtml5Mode** (boolean, optional, default: false)\n\nDisable 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.\n\n\n**basicAuth** (object, optional, default: null)\n\nProtect server with basic HTTP authentication.\n\n```js\nbasicAuth: {\n username: 'username',\n password: 'password'\n}\n```\n\n\n**readOnly** (boolean, optional, default: false)\n\nDisable variable saving from web interface.\n\n\n**customColors** (string, optional)\n\nPath to file that defines custom UI color overrides using PostCSS variables. See all possible variables [here](https://github.com/SC5/sc5-styleguide/blob/master/lib/app/css/_styleguide_variables.css).\n\nInternal 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.\n\nYou can define your own styles with\n\n```css\n@define-mixin styleguide_custom_styles {\n /* Define your styles here */\n}\n```\n\nPostCSS configuration supports mixins, nesting, variables, media queries.\n\n\n**parsers** (object, optional)\n\ndefault:\n\n```js\nparsers: {\n sass: 'scss',\n scss: 'scss',\n less: 'less',\n postcss: 'postcss'\n}\n```\n\nStyleguide 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`.\n\nFor example, to parse all .css files using postcss parser, following configuration could be used:\n\n```js\n{\n css: 'postcss'\n}\n```\n\n\n**styleguideProcessors** (object, optional)\n\ndefault:\n\n```js\nstyleguideProcessors: {}\n```\n\nStyleguide has several processors that enrich or modify the data. For example the `sg-wrapper` replacement is done by a processor.\nYou can add your own processor to enrich the styleguide data with your own content or modifications.\nYou can also override existing functionality by overwriting the related processor.\nCurrently these processors exist by default and should not be overwritten unless you know what you are doing:\n\n```js\nstyleguideProcessors: {\n 10: replaceSectionReferences,\n 20: generateSectionWrapperMarkup\n}\n```\n\nYou can define your own processors:\n\n```js\nstyleguideProcessors: {\n 11: function(styleguide) {\n // this will run after replaceSectionReferences\n styleguide.sections[0].description = styleguide.sections[0].description + ' [Description from custom Processor]';\n },\n 30: function(styleguide) {\n // this will run after generateSectionWrapperMarkup\n }\n}\n```\n\n\n**filesConfig** (array, optional) **(Experimental feature)**\n\nAll 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.\n\nConfiguration array containing paths to the dependencies of the hosted application\n\n```js\nfilesConfig: [\n {\n \"name\": \"NameOfMainAppModule\",\n \"files\": [\n \"path/to/dependency-file.js\",\n \"path/to/application-file.js\",\n \"path/to/stylesheet.css\",\n ],\n \"template\": \"path/to/template-filename.html\"\n }\n]\n```\n\nNote: When using templateUrl in directives, the template path is relative to style guide index.html, not the hosted application root.\n\n**additionalNgDependencies** (array or string, optional)\n\nSome angular libraries (such as angular-material) can't be lazy loaded after bootstrapping.\nYou can use the additionalNgDependencies property to inject additional angular\ndependencies to be bootstrapped by the style guide app.\n\nYou can pass either a string (if you only have one dependency to add) or\nan array of strings. The string(s) should be the same dependencies you would\npass when bootstrapping dependencies in your own modules.\n\nWhen using this property, you should also specify an afterBody or extraHead\nconfig in order to make sure the dependencies are loaded by the browser before\nthey are bootstrapped.\n\nHere's an example showing how to use angular-material:\n\n```js\nadditionalNgDependencies: ['ngMaterial']\nextraHead: '\n \n'\nafterBody: '\n \n \n \n'\n```\n\n## Documenting syntax\n\nDocument your CSS components with [KSS](http://warpspire.com/kss/)\n\n### Defining an Angular directive\n\nIf your components can be rendered with Angular directives, you can define them in KSS markup and so avoid copy-pasting\nin the `markup` field. This is how you can instruct the style guide to use Angular:\n\n```js\n// Test directive\n//\n// markup:\n//
If you see this something is wrong
\n//\n// sg-angular-directive:\n// name: NameOfMainAppModule\n// template: path/to/template-filename.html\n// file: path/to/application-file.js\n//\n// Styleguide 1.2.3\n```\n\nIt is possible to define several files, so you can attach all the needed dependencies:\n\n```js\n// sg-angular-directive:\n// name: NameOfMainAppModule\n// template: path/to/template-filename.html\n// file: path/to/application-file.js\n// file: path/to/dependency-file.js\n// file: path/to/stylesheet.css\n```\n\nYou can also write the same with comma-syntax\n\n```js\n// sg-angular-directive:\n// name: NameOfMainAppModule\n// template: path/to/template-filename.html\n// file: path/to/application-file.js, path/to/dependency-file.js, path/to/stylesheet.css\n```\n\n### Ignore parts of the style sheet from being processed\n\nYou can ignore parts of the CSS or KSS from being processed using the following tags:\n\n```js\n// styleguide:ignore:start\nIgnored styles\n// styleguide:ignore:end\n```\n\n### Wrapper markup\n\nSometimes your component examples need a wrapper. For example:\n\n- you need to show how to use `
  • ` element which works only with `