SassDoc

SassDoc a été inspiré et inspire de JSDoc .
Tout comme ne importe quel autre générateur de documentation, SassDoc fonctionne en saisissant les commentaires des fichiers SASS / SCSS et créer une belle page de documentation HTML, bien organisé hors d'eux.
Tout le contenu est bien structuré en sections pour faire face aux fonctions, variables et mixins. Les références aux extraits de code d'origine et le code source est également mise en évidence en charge.
Outre le thème de SassDoc standard, d'autres modèles sont également disponibles.
Pour utiliser SassDoc se il vous plaît vérifier sa documentation d'abord pour les informations appropriées sur la façon de formater SASS / SCSS commentaires de code source afin qu'ils puissent être détectés et utilisés par le moteur de SassDoc.

Ce qui est nouveau dans cette version:

• Mise à niveau vers Babel 5.0
• Assurer défaut nom du thème est correctement connecté

Mises à jour
• Plusieurs dépendances
• commuté sur ESLint

Ce qui est nouveau dans la version 2.1.1:

• Version mise à jour SASS-convert pour empêcher la 6to5- question d'exécution décrite dans.

Ce qui est nouveau dans la version 2.0.0:

• L'ensemble API a été entièrement remaniée dans ES6
• signe $ est maintenant facultative lors de la définition du nom dansparameter annotation
• Il est maintenant possible d'utiliser des modèles fichier / dossier exclusion
• Il est maintenant possible de tuyau SassDoc dans stdin
• - option de débogage a été ajoutée à l'information sur la configuration de sortie actuelle
• Thème par défaut a maintenant une configuration GoogleAnalytics accepter un suivi Google Analytics touche
• Thème par défaut a maintenant une configuration de trackingcode accepter un code HTML arbitraire être inclus avant & # x3C; / body & # X3e;
• content annotation est maintenant correctement émis dans le thème par défaut
• Thème par défaut affiche désormais le type ainsi que le nom quand réticulation articles (exigences, et ainsi de suite ...)
• Les messages d'erreur devraient maintenant être plus explicite, fournissant un nom de fichier et une ligne
• - analyser option a été ajoutée aux données de sortie d'analyse cru comme JSON de la CLI

Quoi de neuf dans la version 1.10.6:.

• Assurez-type approprié pour vérifiersee annotation

Ce qui est nouveau dans la version 1.10.3:.

• requires empêché autoFill dépendance deux fois

Ce qui est nouveau dans la version 1.8.0:

• Ajout de la possibilité d'ajouter vos propres annotations à votre thème
• Correction d'un problème avec les éléments étant commandé au hasard

Quoi de neuf dans la version 1.6.0:

• Ajout d'un générateur Yeoman pour le rendre plus facile à construire thèmes.
• Ajout du support YAML des fichiers de configuration; nom de fichier de configuration par défaut est toujours voir, soit que .json, .yaml ou .yml.
• Ajout d'un message à mettre en garde contre en se appuyant sur le nom du fichier de configuration par défaut (vue. {JSON, YAML, yml}) car il va briser dans la version 2.0.0 en faveur des .sassdocrc (qui supporte les deux formats à la fois tout étant plus sémantique, moins de confusion et moins susceptibles de conflits avec d'autres projets).
• Correction d'un problème lorsque la valeur des éléments variables contient un point-virgule.
• Amélioration le thème lumière (meilleure bascule encadré avec les États stockées dans localStorage, mieux bascule de code, meilleure structure JavaScript, et une meilleure performance).

Ce qui est nouveau dans la version 1.5.2:

• Ajout de type implicite pour les paramètres fictifs requis

Ce qui est nouveau dans la version 1.4.1:.

• Correction d'un test cassée

Ce qui est nouveau dans la version 1.3.2:.

• Correction d'un test cassée

Quoi de neuf dans la version 1.1.6:

• Backport, fixe trouvé au-par le chemin absolu.

Exigences :

• Node.js