{"id":15163192,"url":"https://github.com/design4pro/kss-loader","last_synced_at":"2025-09-30T17:31:19.422Z","repository":{"id":85778063,"uuid":"91898254","full_name":"design4pro/kss-loader","owner":"design4pro","description":"DEPRECATED. Webpack loader for https://github.com/kss-node/kss-node","archived":true,"fork":false,"pushed_at":"2017-12-29T06:51:30.000Z","size":57,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-14T01:44:35.478Z","etag":null,"topics":["kss","kss-loader","kss-node","webpack-loader","webpack2"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/design4pro.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-20T15:29:36.000Z","updated_at":"2023-01-28T21:16:56.000Z","dependencies_parsed_at":"2023-03-06T18:30:23.071Z","dependency_job_id":null,"html_url":"https://github.com/design4pro/kss-loader","commit_stats":{"total_commits":82,"total_committers":4,"mean_commits":20.5,"dds":0.4024390243902439,"last_synced_commit":"ad0a766f830d4481a3a44a2cc62411f83834d36c"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/design4pro%2Fkss-loader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/design4pro%2Fkss-loader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/design4pro%2Fkss-loader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/design4pro%2Fkss-loader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/design4pro","download_url":"https://codeload.github.com/design4pro/kss-loader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234760689,"owners_count":18882576,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kss","kss-loader","kss-node","webpack-loader","webpack2"],"created_at":"2024-09-27T02:20:41.620Z","updated_at":"2025-09-30T17:31:14.055Z","avatar_url":"https://github.com/design4pro.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kss-loader\n\n[![travis build](https://img.shields.io/travis/design4pro/kss-loader.svg)](https://travis-ci.org/design4pro/kss-loader) [![CircleCI](https://circleci.com/gh/design4pro/kss-loader.svg?\u0026style=shield\u0026circle-token=4b7e0017a6fa6840e65f52e413245bbc5cfa894b)](https://circleci.com/gh/design4pro/kss-loader) [![codecov coverage](https://img.shields.io/codecov/c/gh/design4pro/kss-loader.svg)](https://codecov.io/gh/design4pro/kss-loader) [![npm](https://img.shields.io/npm/v/kss-loader.svg)](https://www.npmjs.com/package/kss-loader) [![npm](https://img.shields.io/npm/dt/kss-loader.svg)](https://www.npmjs.com/package/kss-loader) [![Greenkeeper badge](https://badges.greenkeeper.io/design4pro/kss-loader.svg)](https://greenkeeper.io/)\n\n\u003e Webpack loader for [kss-node](https://github.com/kss-node/kss-node)\n\n## Installation\n\nInstall the plugin with npm:\n\n```shell\nnpm install kss-loader --save-dev\n```\n\n## Usage\n\nWithin your webpack configuration, you'll need to add the kss-loader to the list of modules.\n\n```javascript\nmodule.exports = {\n  // ...\n  module: {\n    rules: [{\n      test: /\\.scss$/,\n      exclude: /(node_modules|bower_components)/,\n      use: {\n        loader: 'kss-loader',\n        options: {\n          title: 'KSS Example',\n          mask: '*.scss|*.css',\n          placeholder: '[modifier class]',\n          source: './scss/',\n          destination: './docs/',\n          homepage: './../README.md'\n        }\n      }\n    }]\n  }\n  // ...\n}\n```\n\n## Options\n\n| Name | Default | Type | Description |\n| --- | --- | --- | --- |\n| `source` |  | `string` | Source directory to recursively parse for KSS comments,homepage, and markup (relative to webpack.config.js file) |\n| `destination` | \"styleguide\" | `string` | Destination directory of style guide (relative to webpack.config.js file) |\n| `mask` | \"\u0026#42;.css\u0026#124;\u0026#42;.less\u0026#124;\u0026#42;.sass\u0026#124;\u0026#42;.scss\u0026#124;\u0026#42;.styl\u0026#124;\u0026#42;.stylus\" | `string` | Use a mask for detecting files containing KSS comments |\n| `config` |  | `string` | Load the kss options from a json file|\n| `builder` | \"builder/handlebars\" | `string` | Use the specified builder when building your style guide |\n| `css` |  | `array` | URL of a CSS file to include in the style guide (relative to the generated style guide) |\n| `js` |  | `array` | URL of a JavaScript file to include in the style guide (relative to the generated style guide) |\n| `custom` |  | `string` | Process a custom property name when parsing KSS comments |\n| `extend` |  | `string` | Location of modules to extend the templating system; see [http://bit.ly/kss-wiki]() |\n| `homepage` | \"homepage.md\" | `string` | File name of the homepage's Markdown file (relative to source) |\n| `markup` | false | `boolean` | Render \"markup\" templates to HTML with the placeholder text |\n| `placeholder` | \"[modifier class]\" | `string` | Placeholder text to use for modifier classes |\n| `nav-depth` | 3 | `number` | Limit the navigation to the depth specified |\n| `title` | \"KSS Style Guide\" | `string` | Title of the style guide |\n\n\n\nFor more options, see [kss-node cli options](https://github.com/kss-node/kss-node#using-the-command-line-tool).\n\n## Example\n\nCheck out the [example](https://github.com/design4pro/kss-loader/blob/master/example/kss/) directory for a simple KSS style guide example.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdesign4pro%2Fkss-loader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdesign4pro%2Fkss-loader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdesign4pro%2Fkss-loader/lists"}