siimple
siimple copied to clipboard
jmjuanes
The minimal and themeable CSS toolkit for flat and clean designs
Welcome to the siimple CSS toolkit repository :tada:
- :globe_with_meridians: Website: www.siimple.xyz.
- :books: Documentation: read our documentation at https://www.siimple.xyz/docs.
- :pencil: Try siimple: play with siimple in your browser with our online playground.
- :pray: Contributing: check out our CONTRIBUTING guide to get started.
- :question: Questions: join our discussion forum.
- :sparkles: Releases: check out our latest releases.
- :leftwards_arrow_with_hook: Documentation for v3: v3.siimple.xyz.
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.
Packages
Along with siimple and siimple-icons packages, the packages listed in the table below are also available on this repository. These packages are published in the @siimple organization in npm.
| Package | Description | Included in siimple |
|---|---|---|
| @siimple/core | Core engine of the siimple CSS toolkit. | :heavy_check_mark: |
| @siimple/modules | Core modules of siimple. | :heavy_check_mark: |
| @siimple/colors | Color palette for siimple. | :heavy_check_mark: |
| @siimple/preset-base | Base theme of siimple. | :heavy_check_mark: |
| @siimple/preset-ice | A frosty and clean theme for siimple. | :x: |
| @siimple/styled | A tiny CSS-in-JS library with the power of the siimple framework. | :x: |
The version of these packages are different from the main siimple and siimple-icons packages, but follows this convention: the version 4.x.y of siimple equals to version 0.x.y of all packages published in the @siimple organization.
Development
Here are the instructions for building siimple from the source code. Before you get started, ensure you have Node 14 and Yarn 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 yarn:
$ yarn install
Build siimple and siimple-icons
Run the following command to build the siimple CSS framework in siimple/siimple.css and the siimple-icons CSS in siimple-icons/siimple-icons.css:
$ yarn run build
Documentation
We are using Gatsby for documentation. After building the CSS of the siimple framework you can build the documentation site with the following command:
$ yarn run build:website
Start the website server with the following command:
$ yarn run serve
License
Code and documentation of siimple © 2015-present Josemi Juanes. Code released under the MIT license. Documentation released under Creative Commons Attribution 4.0.
jmjuanes