SassDoc

SassDoc inspiriert wurde und nach dem JSDoc modelliert.
Genau wie jede andere Dokumentation Generator arbeitet SassDoc durch Greifen Kommentare von SASS / SCSS Dateien und die Schaffung eines schönen, gut organisierte HTML-Dokumentation Seite aus ihnen heraus.
Alle Inhalte werden auch in Abschnitte für den Umgang mit Funktionen, Variablen und Mixins strukturiert. Verweise auf die ursprünglichen Code-Snippets und Source-Code-Highlighting wird ebenfalls unterstützt.
Neben der Standard-SassDoc Thema sind auch andere Vorlagen zur Verfügung.
Um SassDoc verwenden überprüfen Sie bitte deren Dokumentation zunächst für die entsprechende Informationen über das SASS / SCSS Quellcode Kommentare zu formatieren, damit sie erkannt und durch SassDoc des Motors verwendet werden können.

Was ist neu in dieser Pressemitteilung:

• Upgrade zu Babel 5.0
• Stellen Sie sicher, Standard-Theme Name korrekt angemeldet ist
• Mehrere Abhängigkeiten Updates
• wird ESLint Switched

Was ist neu in Version 2.1.1:

• Update Sass-convert-Version zu verhindern, dass die 6to5- Laufzeit-Problem beschrieben.

Was ist neu in der Version 2.0.0:

• Die ganze API wurde vollständig in ES6 umgestaltet
• $ -Zeichen ist nun optional bei der Definition des Namens inparameter Annotation
• Es ist nun möglich, Datei / Ordner-Ausschluss-Muster zu verwenden
• Es ist nun möglich, Rohr SassDoc in stdin
• - Debug-Option wurde zur Ausgabe von Informationen über aktuelle Setup hinzugefügt
• Standard-Design hat jetzt eine Google Konfiguration zu akzeptieren ein Google Analytics-Tracking-Taste
• Standard-Design hat jetzt einen Sendungsnummer Konfiguration Annahme eines beliebigen HTML-Abschnitte, bevor aufgenommen werden & # X3C; / body & # x3e;
• content Annotation ist jetzt im Standard-Theme korrekt ausgegeben
• Standard-Design zeigt nun die Art sowie den Namen, wenn Vernetzung Produkte (Anforderungen, und so weiter ...)
• Fehlermeldungen sollten nun noch deutlicher werden und bietet einen Dateinamen und eine Linie
• - analysieren Option wurde zur Ausgabe raw Parsing-Daten als JSON vom CLI hinzugefügt

Was ist neu in der Version 1.10.6:.

• Stellen Sie sicher, die richtige Typprüfung fürsee Annotation

Was ist in der Version 1.10.3 neu .

• Verhindertrequires die Abhängigkeit zweimal Autofill

Was ist neu in Version 1.8.0:

• Added Möglichkeit, eigene Anmerkungen zu Ihrem Thema hinzufügen
• Es wurde ein Problem mit Einzelteilen, die nach dem Zufallsprinzip geordneten

Was ist neu in Version 1.6.0:

• Es wurde ein Yeoman Generator, um es einfacher zu bauen Themen.
• Added Unterstützung für YAML Konfigurationsdateien; Standard-Konfigurationsdateiname wird immer noch angezeigt werden, entweder als .json, .yaml oder .yml.
• Es wurde eine Nachricht an davor gewarnt, sich auf die Standard-Konfigurationsdatei Namen warnen (Blick. {Json, yaml, yml}), da es in der Version 2.0.0 für .sassdocrc (die sowohl Format unterstützen bricht auf einmal, während Sein mehr semantische, weniger verwirrend und weniger wahrscheinlich zu Konflikten mit anderen Projekten).
• Ein Problem wurde behoben, wenn variable Elemente "Wert ein Semikolon enthält.
• Verbesserte das Licht Thema (besser Sidebar Toggle mit Staaten in localstorage gespeichert, besseren Code Toggle, besser JavaScript Struktur und bessere Leistung).

Was ist neu in Version 1.5.2:

• Hinzugefügt implizite Typ für erforderlich Platzhalter

Was ist neu in Version 1.4.1:.

• Fest ein gebrochener Test

Was ist neu in Version 1.3.2:.

• Fest ein gebrochener Test

Was ist neu in Version 1.1.6:

• Backport, Fest gefunden-at mit absoluten Pfad.

Anforderungen :

• Node.js