Skip to content

Latest commit

 

History

History
112 lines (68 loc) · 3.65 KB

README.md

File metadata and controls

112 lines (68 loc) · 3.65 KB
Raw
siimple-core

siimple

npm npm devDependency Status npm

About

siimple is a light, responsive and open source framework for design flat and clean websites. It has been built in SASS/SCSS and provides a clean starting point for your web design.

You can find the documentation and the reference guide in https://www.siimple.xyz/documentation

Getting started

First, install siimple in your project using one of the following methods:

Using npm (recomended)

Install the latest version from npm:

npm install --save siimple

Using bower

Install the latest version from bower:

bower install siimple --save

Clone the git repository

You can also clone the git repository hosted on GitHub:

git clone https://github.com/siimple/siimple.git

Usage

The main css file is located in the dist/ folder. Include it on every HTML file of your project by adding the following tag:

<link rel="stylesheet" type="text/css" href="./path/to/siimple/dist/siimple.css">

Or you can use the hosted version on jsDelivr:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/siimple@VERSION/dist/siimple.min.css">

Guides and reference are published in https://www.siimple.xyz/documentation. Take a look and start creating your web page!

Using the SCSS/SASS mixins

You can use the SASS/SCSS mixins located in the scss/ folder. For this, first install siimple and all his dependencies using NPM:

npm install siimple

This will create a folder called node_modules with the latest version of siimple. Then, import all mixins in your .scss files by adding the following line:

@import "siimple/scss/_all.scss"

Remember that you must add the node_modules path to the SASS load_paths option. If you are using libsass with gulp, here is an example of usage: https://github.com/siimple/siimple/blob/ae838b102b2a585a91453fb8e347a680b3bec22e/scripts/build.js#L41.

Build siimple

First, clone this repository:

git clone https://github.com/siimple/siimple.git

Now, cd to the siimple repository and install all the develop dependencies using npm:

npm install

Compile the SCSS files and generate the .css files in the dist/ folder by running the following command

npm run build

Also, the previous command will generate the minimized version of siimple.

Contribute

We appreciate all contributions to the siimple project and help make it better! Please, read the contributing guidelines before starting your contribution.

License

siimple is under the MIT license. © The siimple team.