|
2 years ago | |
---|---|---|
assets | 2 years ago | |
dist/css | 2 years ago | |
docs | 2 years ago | |
scripts | 2 years ago | |
src/sass | 2 years ago | |
tests | 2 years ago | |
.editorconfig | 2 years ago | |
.gitattributes | 2 years ago | |
.gitignore | 2 years ago | |
.gitmessage | 2 years ago | |
.sass-lint.yml | 2 years ago | |
KUDOS.txt | 2 years ago | |
LICENSE | 2 years ago | |
README.md | 2 years ago |
README.md
Style-Cheat
The simple, modular and expandable CSS Framework.
Motivation
Initially, Style-Cheat was written to learn more about CSS, SASS and web technologies. Nowadays, it is developed and maintained as the "design-backend" for upcoming services, presentations and other decorations made by while-true-do.io.
Description
Style-Cheat is developed with some core paradigms in mind, that should support a fast implementation and ease-of-use.
Features
The key-features are:
- documented: you can read about each and every functionality
- modern: you don't have to bother about legacy or deprecated code
- small: you don't need to fear loading times
- simple: you can understand it fast and use it quickly
- modular: you can use what you need
- expandable: you don't need to fear conflicts with your own code
Compatibility
We are focusing on compatibility with modern browsers:
- Firefox 78 (ESR)+
- Chromium 90+
Installation
The installation of Style Cheat is quite easy. Just point your browser to the proper files and you are set up.
Download
You can download the latest release from here.
After downloading the release file, you need to unpack it and use it in your
<header>
section of your HTML file.
<!-- Use Style-Cheat CSS (expanded)-->
<link rel="stylesheet" href="path/to/style-cheat.css" />
<!-- Use Style-Cheat CSS (compressed) -->
<link rel="stylesheet" href="path/to/style-cheat.min.css" />
CDN
Style-Cheat CSS is available at jsdelivr CDN.
<!-- Use Style-Cheat CSS (expanded)-->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/style-cheat/css@1.0/dist/style-cheat.css" />
<!-- Use Style-Cheat CSS (compressed) -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/style-cheat/css@1.0/dist/style-cheat.min.css" />
Bower
TBD
NPM
TBD
Usage
TBD
Known Issues
TBD
Changelog
TBD
Contribute
Thank you so much for considering to contribute! We are happy, when someone is joining the hard work. Please feel free to contribute, after having a look at the Conventions.
See who has contributed already in the KUDOS.txt.
Develop
TBD
Test
TBD
License
Except where otherwise noted, all work is licensed under a BSD-3-Clause License.