liser
Version:
functional css help to optimizing design work and building responsive websites
129 lines (77 loc) • 3.08 kB
Markdown
# liser
[![npm version][npm-version-image]][npm-url]
[![npm version stable][npm-version-stable-image]][npm-version-stable-url]
[![npm downloads][npm-downloads-image]][npm-url]
[![github issues][github-issues-image]][github-issues-url]
functional css help to optimizing design work and building responsive websites. liser help you create the module contains the css properties you need to use quickly and lightest!
# usage
## self-generated
### step 1
#### clone liser repository
```bash
$ git clone https://github.com/lamhieu-vk/liser.git
```
### step 2
#### create a modules
- create a directory with the name `example` located at `/src/modules`
- create a file with the same name as the directory (with the extension `.css`) at `/src`
- import all the components from `/src/modules/example` directory into the file `/src/example.css`
and now you have a new module
### step 3
#### build official files
```bash
$ npm run build
```
it will run build main files and build split files to dir `/build`
#### build main files
```bash
$ npm run build:main
```
#### build split files
```bash
$ npm run build:split
```
#### build a module
```bash
$ name={module_name} npm run build:module {...modules_list}
```
[**module_name**]: replace with a name you want
[**...modules_list**]: replace with list name of modules you need build (in `/src`). exmaple: box-shadow colors widths
```bash
example:
$ name=simple npm run build:module box-shadow colors widths
```
module name is `simple` and it will combine `box-shadow` `colors` `widths` modules
### step 4
after build completed, you can use that file for your site
## library
### full modules
```html
<link rel="stylesheet" href="https://unpkg.com/liser/build/liser.min.css">
<link rel="stylesheet" href="https://unpkg.com/liser@stable/build/liser.min.css">
```
### once module
```html
<link rel="stylesheet" href="https://unpkg.com/liser/build/liser.[module].min.css">
<link rel="stylesheet" href="https://unpkg.com/liser@stable/build/liser.[module].min.css">
```
# updated
updated history, [read more](https://github.com/lamhieu-vk/liser/tree/master/updated.md)
# sites
sites built with liser, [read more](https://github.com/lamhieu-vk/liser/tree/master/sites.md)
# todos
- [-] fork modules from [ciser](https://github.com/lamhieu-vk/ciser) to liser. can you help me? it's great!
# modules
these are already supported modules, [read more](https://github.com/lamhieu-vk/liser/tree/master/modules.md)
# version
### stable: 0.2.4
### lastest: 0.2.4
# license
[MIT](https://github.com/lamhieu-vk/liser/blob/master/LICENSE)
[npm-url]: https://npmjs.org/package/liser
[npm-version-image]: https://badge.fury.io/js/liser.svg
[npm-downloads-image]: https://img.shields.io/npm/dm/liser.svg
[npm-version-stable-image]: https://img.shields.io/badge/stable-0.2.4-brightgreen.svg
[npm-version-stable-url]: https://unpkg.com/liser@stable/build/liser.min.css
[github-issues-image]: https://img.shields.io/github/issues/lamhieu-vk/liser.svg
[github-issues-url]: https://github.com/lamhieu-vk/liser/issues