Skip to content

Latest commit

 

History

History
66 lines (54 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

66 lines (54 loc) · 1.34 KB
Raw

Contributing

Hi, thanks for taking your time to take a look at how to help funkcss.

Dependencies

Setup

$ git clone https://github.com/filipelinhares/funkcss.git
$ cd funkcss
$ npm run setup

File structure

All funkcss source code is found in the lib directory.

The files are separeted by group:

└── lib
  ├── border.css
  ├── default-gaps.css
  ├── flex.css
  ├── index.css
  ├── layout.css
  ├── lists.css
  ├── objects.css
  ├── sizes.css
  ├── spacing.css
  └── typography.css

The dist directory contain the minified version compiled with gulp.

└── dist
  ├── funkcss-immutable.min.css
  └── funkcss.min.css

Other npm commands

Compile

$ npm run compile

Use postcss modules to generate the dist/funkcss.css file.

Minify

$ npm run minify

Generates dist/funkcss.min.css from dist/funkcss.css.

Immutable

$ npm run immutable

Generates dist/funkcss-immutable.min.css from dist/funkcss.min.css.

Build

$ npm run build

This commands is an alias to compile, minify and immutable commands.

⇠ Back to home