Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/geckotang/kss-node-template


https://github.com/geckotang/kss-node-template

Last synced: 20 days ago
JSON representation

Awesome Lists containing this project

README

        

# kss-node-template

This is a template for [kss-node v2.x](https://github.com/kss-node/kss-node) styleguide.

## How to use

### Install

```
$ git clone [email protected]:geckotang/kss-node-template.git
$ cd kss-node-template
$ npm install
```

### Build Styleguide

this template parses css in `src/scss` directory.
you can build styleguide when you put scss file to `src/scss`.

```bash
$ gulp build
```

### Configuration file for Your Styleguide

If you want to change the styleguide title, please edit `site-setting.json` in `custom-template/`.

```json
{
"docTitle": "MY Styleguide",
"generatorTag": ""
}
```

this configuration file is used in `custom-template/index.html`.

```html


{{site-setting "docTitle"}}

{{site-setting "generatorTag"}}