Welcome to the siimple CSS toolkit repository
📚Documentation: read our documentation at https://www.siimple.xyz. 📝Try siimple: play with siimple in your browser with our online playground. 🙏Contributing: check out our CONTRIBUTING guide to get started. ❓Questions: join our discussion forum. 🐦Stay tunned: follow us on twitter.
What is siimple
We call siimple a CSS toolkit because it is a themeable and customizable CSS framework, but also a CSS engine that you can use for building your own CSS framework.
Inspired by other CSS frameworks (like bulma), but:
- Fully themeable: use your own theme to customize and extend siimple.
- Use what you really need: include the core modules (elements, helpers, ...) and themes that you REALLY need for your project.
- No dependencies: written all from scratch without any dependencies.
- No CSS preprocessors needed: we provide a tiny CLI to compile the CSS, so you do not need any other preprocessor like SASS or LESS.
- Color palette included: we provide a flat color palette to customize siimple with different colors.
- Pure CSS icons included: we provide a collection of pure CSS icons.
Along with the main
siimple package, the packages listed in the table below are also available on this repository. These packages are published in the
@siimple organization in npm.
|@siimple/core||Core engine of the siimple CSS toolkit.|
|@siimple/modules||Core modules of siimple.|
|@siimple/colors||Color palette for siimple.|
|@siimple/preset-theme||Default theme of siimple.|
The version of these packages are different from the main
siimple package, but follows this convention: the version
siimple equals to version
0.x.y of all packages published in the
Here are the instructions for building siimple from the source code. Before you get started, ensure you have Node and NPM installed in your computer.
First clone this repository in your local machine running the following command:
$ git clone https://github.com/jmjuanes/siimple
Navigate into the repository folder and then install dependencies with npm:
$ npm run install
Generate the framework CSS
Run the following command to generate the CSS of the siimple framework in
$ npm run build
You can run the playground editor in your local machine after building the framework CSS and then running the following command:
$ npm run playground
We are using Gatsby for documentation. After building the CSS of the siimple framework you can build and start the documentation site running the following command:
$ npm run website