https://github.com/previousnext/kss-node-offscreen-template
A kss-node template with offscreen menu and search
https://github.com/previousnext/kss-node-offscreen-template
kss styleguide
Last synced: 2 months ago
JSON representation
A kss-node template with offscreen menu and search
- Host: GitHub
- URL: https://github.com/previousnext/kss-node-offscreen-template
- Owner: previousnext
- Created: 2016-03-03T04:12:50.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-14T23:53:17.000Z (over 4 years ago)
- Last Synced: 2025-03-28T10:52:12.796Z (2 months ago)
- Topics: kss, styleguide
- Language: JavaScript
- Homepage:
- Size: 210 KB
- Stars: 0
- Watchers: 13
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Builder for kss-node with offscreen menu
**Requires KKS-node 3.0.x**
This is a **builder** for [kss-node](https://github.com/kss-node/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](https://previousnext.github.io/kss-node-offscreen-template/).
## 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 --builder path/to/kss-node-offscreen-template
```