Kapsiki-design NPM

Kapsiki Design 1

Our default branch is for development of our Kapsiki Design 1 release.

Quick start

Several quick start options are available:

Clone the repo: git clone https://github.com/kapsiki/kapsiki-design.git
Install with npm: npm install kapsiki-design@v1.0.0
Install with yarn: yarn add kapsiki-design@v1.0.0

Read the Getting started page for information on the framework contents, templates, examples, and more.

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations.

kapsiki/
├── css/
│   ├── kapsiki-grid.css
│   ├── kapsiki-grid.css.map
│   ├── kapsiki-grid.min.css
│   ├── kapsiki-grid.min.css.map
│   ├── kapsiki-grid.rtl.css
│   ├── kapsiki-grid.rtl.css.map
│   ├── kapsiki-grid.rtl.min.css
│   ├── kapsiki-grid.rtl.min.css.map
│   ├── kapsiki-reboot.css
│   ├── kapsiki-reboot.css.map
│   ├── kapsiki-reboot.min.css
│   ├── kapsiki-reboot.min.css.map
│   ├── kapsiki-reboot.rtl.css
│   ├── kapsiki-reboot.rtl.css.map
│   ├── kapsiki-reboot.rtl.min.css
│   ├── kapsiki-reboot.rtl.min.css.map
│   ├── kapsiki-utilities.css
│   ├── kapsiki-utilities.css.map
│   ├── kapsiki-utilities.min.css
│   ├── kapsiki-utilities.min.css.map
│   ├── kapsiki-utilities.rtl.css
│   ├── kapsiki-utilities.rtl.css.map
│   ├── kapsiki-utilities.rtl.min.css
│   ├── kapsiki-utilities.rtl.min.css.map
│   ├── kapsiki.css
│   ├── kapsiki.css.map
│   ├── kapsiki.min.css
│   ├── kapsiki.min.css.map
│   ├── kapsiki.rtl.css
│   ├── kapsiki.rtl.css.map
│   ├── kapsiki.rtl.min.css
│   └── kapsiki.rtl.min.css.map
└── js/
    ├── kapsiki.bundle.js
    ├── kapsiki.bundle.js.map
    ├── kapsiki.bundle.min.js
    ├── kapsiki.bundle.min.js.map
    ├── kapsiki.esm.js
    ├── kapsiki.esm.js.map
    ├── kapsiki.esm.min.js
    ├── kapsiki.esm.min.js.map
    ├── kapsiki.js
    ├── kapsiki.js.map
    ├── kapsiki.min.js
    └── kapsiki.min.js.map

We provide compiled CSS and JS (kapsiki.*), as well as compiled and minified CSS and JS (kapsiki.min.*). Source maps (kapsiki.*.map) are available for use with certain browsers' developer tools. Bundled JS files (kapsiki.bundle.js and minified kapsiki.bundle.min.js) include Popper.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

Kapsiki Design's documentation, included in this repo in the root directory, is built with Hugo and publicly hosted on GitHub Pages at https://www.kapsiki.net/. The docs may also be run locally.

Documentation search is powered by Algolia's DocSearch.

Running documentation locally

Run npm install to install the Node.js dependencies, including Hugo (the site builder).
Run npm run test (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
From the root /kapsiki-design directory, run npm run docs-serve in the command line.
Open http://localhost:9001/ in your browser, and voilà.

Learn more about using Hugo by reading its documentation.