Getting started

FlatifyCSS is available for users in many ways, you can install it using package managers, directly from CDN, or even downloading the lastest project archive.

CDN

Here is jsDelivr, you can add FlatifyCSS just with a single line of code:

<!-- CSS -->
<link
  href="https://cdn.jsdelivr.net/npm/flatifycss/dist/css/flatify.min.css"
  rel="stylesheet"
  crossorigin="anonymous"
/>

<!-- JavaScript : Popperjs + FlatifyCSS -->
<script src="https://unpkg.com/@popperjs/core@2" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/flatifycss/dist/js/flatify.min.js" crossorigin="anonymous"></script>

Package managers

You can include FlatifyCSS in your project with npm, yarn or composer:

npm

npm install flatifycss

Yarn

yarn add flatifycss

Composer

composer require amir2mi/flatifycss

Contents

After installing FlatifyCSS with package managers or downloading the archive file there is a folder called /dist, where compiled CSS, JS and their map files are there, inside this folder these files are provided:

CSS

CSS files come with some options, files with -noprefix suffix, do not have PostCSS Autoprefixer, while -min means this file is minified and -rtl is the special file for languages like Arabic, Persian, Hebrew, etc which direction is right to left.

flatify.css
flatify-min.css
flatify-noprefix.css
flatify-noprefix-min.css
flatify-rtl.css
flatify-rtl-min.css
flatify-rtl-noprefix.css
flatify-rtl-noprefix-min.css

JS

Note that FlatifyCSS needs Popperjs for dropdowns and popovers, but this library is not included inside the JavaScript file of FlatifyCSS, so it is up to you to include it inside your webpage.

flatify.js
flatify-min.js

Development

FlatifyCSS gets compiled to CSS & JavaScript using Gulp. To use Gulp, we need to install it globally with npm i gulp-cli -g, then run npm install in the root directory of FlatifyCSS.
If everything is okay, we can run gulp in the root directory to compile the stylesheet and JavaScript file, read more about FlatifyCSS's Gulp tasks here.

Support

We appreciate your contribution it is the best way you can help us, however if you want you can buy a coffee!