Est-ce que quelqu'un connaît un outil de documentation CSS?

Question

Nous avons récemment reconstruit notre site en utilisant les principes OOCSS qui permettent une manière vraiment modulaire d’écrire des CSS.

Le site est volumineux et de nombreux développeurs y travaillent. Je souhaite donc pouvoir documenter le CSS afin que les modules CSS soient réutilisés le plus efficacement possible.

Quelqu'un at-il déjà utilisé un outil de documentation CSS automatisé? Ou adapter un autre outil de documentation pour utiliser les fichiers CSS?

Answer 1

Il y a un nouvel outil appelé Knyle les feuilles de style (KSS) qui est utilisé pour le CSS de la Documentation.

http://www.webmonkey.com/2011/12/write-better-css-with-knyle-style-sheets/

https://github.com/kneath/kss

Page d'accueil: http://warpspire.com/kss/

E. g., http://assets.warpspire.com/images/kss/styleguide-full.png

Answer 2

CSS_DOC

CSS_Doc. Le blog à l'expliquer.

Et un exemple de commentaire de documentation

  /**
  * Reset text color and line height.
  */
  body {
    line-height: 1;
    color: black;
    background: white;
  }

C'est une application en Ruby de CSSDOC. Un court tutoriel sur la mise en route Avec CSSDOC Commentaires

Answer 3

Étant donné que cela reste assez fréquent dans les recherches Google apparentées: je suggère également de consulter https://github.com/kneath/kss .

Answer 4

La meilleure façon de documenter CSS pour promouvoir la réutilisation consiste à avoir un document de guide de style. Le document peut définir les styles, leur mode d'utilisation, leur utilisation, et fournir des exemples (de code et graphiques). Le simple fait de mettre des commentaires dans un fichier CSS n'est généralement pas suffisant - le document de guide de style peut inclure une image affichant l'aspect de l'élément correct avec le style correct qui lui est appliqué. Vous ne pouvez pas obtenir cela avec de simples commentaires.

Answer 5

StyleDocco est un autre générateur de documents CSS: https://github.com/jacobrask/styledocco