kss-node-offscreen-template

A custom handlebars buidler for KSS node with an offscreen menu and search.

Usage no npm install needed!

<script type="module">
  import kssNodeOffscreenTemplate from 'https://cdn.skypack.dev/kss-node-offscreen-template';
</script>

README

Builder for kss-node with offscreen menu

Requires KKS-node 3.0.x

This is a builder for kss-node living styleguide. It feature a toggle-able sidebar menu so you can choose to see the styleguide at full browser width. It also has a search function to easily find your component.

You can see the demo here.

How to apply this builder

  1. Install kss-node. Type npm install kss or npm install -g kss for global CLI.
  2. Install this template npm install kss-node-offscreen-template
  3. Run kss-node command with --builder option, like below.
kss-node <sourcedir> --builder path/to/kss-node-offscreen-template