KNACSS/README.md

117 lines
8.3 KiB
Markdown
Raw Normal View History

2015-03-06 16:03:28 +01:00
# KNACSS
2013-03-31 10:52:41 +02:00
http://www.knacss.com
2013-03-31 10:30:11 +02:00
2015-03-06 16:03:28 +01:00
KNACSS, c'est un peu comme une feuille de style CSS "reset" sur-vitaminée qui permet de commencer un projet à partir de zéro tout en tenant compte de bonnes pratiques générales (accessibilité, performance, responsive webdesign).
2015-03-30 16:03:21 +02:00
<hr>
2015-03-06 16:03:28 +01:00
KNACSS prend en charge les styles de base, mais également la typographie, les modèles de boîte, les alignements et positionnements d'éléments, les grilles de mise en page, dans l'esprit d'être adapté à toutes les tailles d'écran (reponsive). Le tout automatiquement !
2015-03-06 16:37:09 +01:00
Conçu par l'agence web [Alsacreations.fr](http://alsacreations.fr) et pensé pour être couplé avec des préprocesseurs tels que LESS ou Sass, le micro-framework KNACSS est employé quotidiennement sur toute sorte de projets web quel que soit son type ou son envergure.
2013-03-31 10:32:01 +02:00
2015-03-06 16:03:28 +01:00
## Installation
2013-03-31 10:30:11 +02:00
2015-03-06 16:03:28 +01:00
La version courte est "il n'y a rien à installer".
2015-03-06 16:22:20 +01:00
Selon votre environnement de travail vous suffit de récupérer la feuille de styles :
- en version [CSS classique](https://raw.githubusercontent.com/raphaelgoetter/KNACSS/master/css/knacss-unminified.css) (ou [minifié](vhttps://raw.githubusercontent.com/raphaelgoetter/KNACSS/master/css/knacss.css))
- en version [LESS](https://github.com/raphaelgoetter/KNACSS/tree/master/less)
- en version [Sass](https://github.com/raphaelgoetter/KNACSS/tree/master/sass)
_Les versions LESS et Sass seront bien évidemment plus malléables grâce à l'apport de variables et fonctions._
2015-03-30 16:48:01 +02:00
À noter que KNACSS est basé sur un socle [Normalize.css](http://necolas.github.io/normalize.css/), célèbre - et éprouvé - reset CSS employé par Twitter, Github, Bootstrap, Guardian, etc.
2015-03-06 16:22:20 +01:00
## Usage
2015-03-06 16:03:28 +01:00
KNACSS n'est constitué que d'un seul fichier CSS (minifié ou non selon vos goûts), qu'il vous suffit d'ajouter à votre page HTML :
2013-03-31 10:30:11 +02:00
2015-03-06 16:03:28 +01:00
<link rel="stylesheet" href="knacss.css">
2013-03-31 10:30:11 +02:00
2015-03-06 16:22:20 +01:00
Il est également possible de l'installer (toutes versions) via [Bower](http://bower.io/) : ```bower install knacss```
2013-12-28 21:57:59 +01:00
2015-04-26 16:12:24 +02:00
## Compatibilité
KNACSS est - dans sa grande majorité - compatible avec l'ensemble des navigateurs à partir d'IE8 inclus.
Seules exceptions :
- les positionnements avancés à base de Flexbox (IE10+ minimum), c'est à dire toutes les classes débutant par `.flex-`
2015-07-08 09:34:56 +02:00
- les grilles de mise en page, également basées sur flexbox (IE10, Android 4.4+), c'est à dire toutes les classes débutant par `.grid-`. Note : une alternative, basée sur `inline-block` est cependant proposée automatiquement pour les anciens navigateurs (IE8, Android 2).
2015-04-26 16:12:24 +02:00
2015-12-24 09:40:14 +01:00
## Juste une grille ?
2015-12-24 12:11:16 +01:00
KNACSS en version complète ne vous convient pas&nbsp;? Seule la grille flexbox vous intéresse&nbsp;? Bienvenue dans *Grillade* !
2015-12-24 10:50:43 +01:00
### via LESS ou Sass ?
Il est possible de n'utiliser KNACSS que pour sa fonctionnalité de grille de positionnement et de bénéficier de colonnes égales, inégales, responsive, des offsets, des pull et push et des mises en exergue. Bref, de [tout l'attirail des grilles KNACSS](https://github.com/alsacreations/KNACSS/blob/master/doc/03-grilles.md).
2015-12-24 11:21:32 +01:00
Il vous suffit pour cela de récupérer l'un ou l'autre fichier selon votre choix de préprocesseur :
- [grillade.less](https://raw.githubusercontent.com/alsacreations/KNACSS/master/css/grillade.less)
- [grillade.scss](https://raw.githubusercontent.com/alsacreations/KNACSS/master/css/grillade.scss)
Ces fichiers ne sont rien d'autre que la concaténation de deux fichiers essentiels :
- `_00-config.less|scss` (nécessaire pour les variables, les tailles de gouttières et les valeurs de breakpoints)
- `_03-grids.less|scss` (ben oui, quand même)
2015-12-24 10:50:43 +01:00
### vous êtes plutôt nature ?
2015-12-24 09:40:14 +01:00
Vous souhaitez simplement bénéficier d'une grille de mise en page simple mais fonctionnelle, en pur CSS sans passer par LESS ou Sass&nbsp;?
Alors contentez-vous du fichier <a href="https://raw.githubusercontent.com/alsacreations/KNACSS/master/css/grillade.css"><strong>grillade.css</strong></a>, il ne pèse que 4.2ko seulement&nbsp;!
2015-12-24 10:50:43 +01:00
Par contre, n'oubliez quand même pas de lire [la documentation](https://github.com/alsacreations/KNACSS/blob/master/doc/03-grilles.md) que l'on a concoctée rien que pour vous.
2015-12-24 09:40:14 +01:00
2015-09-09 12:42:31 +02:00
## Documentation
2013-06-25 19:43:19 +02:00
2015-03-06 16:22:20 +01:00
KNACSS se veut être un outil simple (contrairement aux usines à gaz que sont Bootstrap ou Foundation), mais évolutif.
La contrepartie est que cela nécessite de votre part de bonnes connaissances en CSS et un petit effort de compréhension et de d'apprentissage des mécanismes de l'outil.
2015-09-09 12:42:31 +02:00
Je vous invite vivement à parcourir la [**documentation**](https://github.com/raphaelgoetter/KNACSS/tree/master/doc) avant de vous jeter sur KNACSS.
2015-03-06 16:03:28 +01:00
2015-04-03 18:17:06 +02:00
Sachez qu'un [pense-bête en PDF](http://knacss.com/KNACSS-cheatsheet.pdf) est également disponible pour vous rappeler des classes utiles de KNACSS.
2015-09-09 12:42:31 +02:00
<p>Vous y trouverez en détail, avec codes et illustrations, les différentes sections suivantes&nbsp;:</p>
2015-09-09 12:44:35 +02:00
<ol>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/00-commencer.md">Comment débuter avec KNACSS</a></li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/01-typo-et-reset.md">Typographie et reset</a></li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/02a-layout-alignements.md">Gérer les alignements de base</a></li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/02b-layout-positionnement.md">Gérer le positionnement des éléments</a></li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/03-grilles.md">Construire des grilles de mise en page</a></li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/04-tableaux.md">Styler les tableaux</a></li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/05-formulaires.md">Styler les formulaires</a></li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/06-helpers.md">Classes "visuelles"</a> (marges et largeurs)</li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/07-responsive.md">Responsive Webdesign</a></li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/08-print.md">Styles pour l'impression</a></li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/09-misc.md">Styles divers (césures, Google Maps, liens d'évitement)</a></li>
<li><a href="https://github.com/raphaelgoetter/KNACSS/blob/master/doc/11-wordpress.md">Adaptations pour WordPress</a></li>
</ol>
2015-09-09 12:42:31 +02:00
2013-03-31 10:30:11 +02:00
2015-03-06 16:03:28 +01:00
## Préprocesseurs
2015-03-06 16:34:29 +01:00
KNACSS est conçu et pensé pour être adapté aux préprocesseurs que sont LESS et Sass. Nous employons LESS en interne, nos fichiers de travail sont donc des `.less` et non des `.css` (cela fonctionne aussi avec Sass).
2014-05-12 11:01:36 +02:00
2015-03-06 16:34:29 +01:00
Si, comme nous, vous intégrez à l'aide de préprocesseurs, KNACSS va vous faciliter la vie dès le début du projet puisqu'un [fichier de configuration](https://github.com/raphaelgoetter/KNACSS/blob/master/less/_00-config.less) contenant toutes les variables du projet est intégré.
Libre à vous de le modifier selon les contraintes de votre projet.
2014-05-12 11:01:36 +02:00
2015-03-06 16:34:29 +01:00
**Attention**, si vous importez KNACSS automatiquement via Bower par exemple (dans un dossier `vendor`), ce fichier de configuration risque d'être écrasé à chaque mise à jour de KNACSS. Nous vous invitons à en faire une copie dans votre dossier de travail et à commenter l'appel au fichier de config de `vendor`.
### Préfixes navigateurs
Certaines fonctionnalités avancées de KNACSS nécessitent d'employer toute une panoplie de préfixes CSS (`-webkit-`, `-moz-`, `-ms-`, ...) pour être certain que les propriétés CSS fonctionneront partout.
2015-03-30 09:42:29 +02:00
Au sein de la version classique CSS de KNACSS, l'ensemble des préfixes est présent, **vous n'avez donc pas à vous en soucier** (paramètres de Autoprefixer : "last 2 versions").
2015-03-06 16:34:29 +01:00
**Par contre, dans les versions LESS et Sass de KNACSS, les préfixes n'apparaissent pas** pour ne pas polluer la lecture du fichier de travail. **Il vous sera donc nécessaire de les ajouter**, de préférence automatiquement grâce à un plugin ou aux excellents outils que sont [autoprefixer](https://github.com/postcss/autoprefixer) ou [pleeease](http://pleeease.io/).
2014-05-12 11:01:36 +02:00
2015-03-06 16:03:28 +01:00
## Liens utiles
2015-03-06 16:34:29 +01:00
* Site web de KNACSS : http://knacss.com
* [**Documentation détaillée**](https://github.com/raphaelgoetter/KNACSS/tree/master/doc)
* Sur Alsacreations.com : ["découverte du framework KNACSS"](http://www.alsacreations.com/tuto/lire/1577-decouverte-du-framework-css-KNACSS.html)
2015-03-30 15:55:55 +02:00
* Générateur de gabarits HTML/CSS : ["Schnaps.it"](http://schnaps.it/)