spec

the CSS framework specification toolkitoutil de spécification pour framework CSS

Specify a CSS framework requirements. Generate its documentation. Validate a DOM for its spec and guidelines conformance.Spécifiez le périmètre de votre framework CSS. Générez sa documentation. Conformez un contenu à ses specs.

What do these CSS framework docs have in common?Qu'ont ces documentations en commun ?

bootstrap
bootstrap 4.1.3
minicss
minicss 3.0.0

They are generated from specsElles sont générées depuis des specs

1. Specify requirements1 - Spécifiez votre framework CSS

Spec helps specify a CSS framework requirements and usage with the help of a .spec file (example), able to list each and every elements, components, with all of their modifiers and facets.Avec spec, spécifiez un framework CSS dans ses moindres détails à l'aide d'un fichier .spec (exemple), permettant de lister l'ensembles des éléments et composants, ainsi que leurs modifieurs et facettes.

2. Generate the documentation2 - Générez automatiquement la doc

Based on the CSS framework spec, the corresponding documentation is automatically generated, documenting every elements and components of the framework, and creating as many examples as there are facets.La documentation est générée automatiquement sur la base des spécifications réalisées en amont. On y retrouve alors l'intégralité des éléments et composants du framework, avec autant d'exemples qu'il existe de facettes.

3. Validate a page conformance3 - Validez une implémentation HTML

A CSS framework spec should also include DOM-based constraints. Such rules help prevent pushing a container inside a button for instance. Based on these rules, spec can help with requirements and guidelines conformance.Une spec de framework CSS devrait également inclure les contraintes de DOM. Celles-ci permettent d'éviter un mauvais usage des éléments. Spec peut se baser sur des règles afin de vérifier la conformance d'un DOM donné.

Special featuresFonctionnalités

Exhaustive specificationSpécification exhaustive

Model every component, every layout mechanism, every facets, and get an exhaustive view of your framework.Modélisez chaque composant, chaque mécaniques de mise en forme, chaque facette, et obtenez une vue globale de votre framework. Résultat : une documentation complète et exhaustive.

Examples, examples, examplesDes exemples en abondance

Spec generates as many examples as there are facets to elements. The result is clear: a thorough and complete documentation.Spec génère autant d'exemples que de familles de facettes pour chaque composant. Résultat : une documentation aussi complète que minutieuse.

Go specDémarrer avec spec

Install specInstaller spec

Grab the codeAccéder aux sources