@bpiwek/frontbox-kss-styleguide

Fronbox KSS Styleguide

Usage no npm install needed!

<script type="module">
  import bpiwekFrontboxKssStyleguide from 'https://cdn.skypack.dev/@bpiwek/frontbox-kss-styleguide';
</script>

README

FrontBox KSS Styleguide by Bartosz Piwek

Template for the KSS-node styleguide

Install

Add package on your project

npm i @bpiwek/frontbox-kss-styleguide

or

yarn add @bpiwek/frontbox-kss-styleguide

Usage

Be sure to be familiar with kss-node.

Create config file kss-config.json in your root project folder and past below config:

{
  "title": "...",
  "builder": "node_modules/@bpiwek/frontbox-kss-styleguide/dist/",
  "extend": "node_modules/@bpiwek/frontbox-kss-styleguide/dist/helpers/",
  "destination": "documentation/",
  "homepage": "README.md",
  "custom": ["Function", "Style", "Usage", "HTML"]
}

Develop

Make sure to install this fallowing plugins for Visual Code Studio before making changes.

Bugs

Feel free to report bug using this link.