SassDoc

SassDoc a fost inspirat și modelat după JSDoc .
La fel ca orice alt generator de documentație, SassDoc lucrări de hapsân comentarii din partea fișiere SASS / SCSS și crearea unui bine organizat pagină frumoasă, documentare HTML din ele.
Întregul conținut este bine structurat in sectiuni pentru a face cu funcții, variabile, și mixins. Trimiterile la fragmente de cod originale și codul sursă evidențierea este de asemenea susținută.
Pe lângă tema SassDoc standard alte template-uri sunt de asemenea disponibile.
Pentru a utiliza SassDoc, vă rugăm să verificați documentația sa în primul rând pentru informațiile corespunzătoare cu privire la modul în care sa format comentariile de cod sursă SASS / SCSS astfel încât să poată fi detectate și utilizate de motorul SassDoc lui.

Ce este nou în această versiune:

• Upgrade Babel 5,0
• Asigurați-vă implicit nume temă este conectat corect
• câteva dependențe noutati
• comutat la ESLint

Ce este nou în versiunea 2.1.1:

• Versiunea Actualizare Sass-convert pentru a preveni 6to5- problemă de execuție a descris în.

Ce este nou în versiunea 2.0.0:

• tot API a fost refactored complet în ES6
• $ semn este acum opțională la definirea denumirea de laparameter adnotare
• Acum este posibil de a utiliza modele de excludere fișier / folder
• Acum este posibil să SassDoc țeavă în stdin
• - opțiune debug a fost adăugat la informații despre configurarea ieșire curent
• Tema grafică preselectată are acum o configurație googleAnalytics acceptarea unei Google Analytics cheie de urmărire
• Tema grafică preselectată are acum o configurație trackingCode acceptarea unui fragment de HTML arbitrar pentru a fi incluse înainte & # x3c; / body & # x3e;
• content adnotare este acum de ieșire corect în temă implicit
• Tema grafică preselectată afișează acum tipul precum și numele când reticulare articole (cerințe, și așa mai departe ...)
• Mesaje de eroare ar trebui să fie acum mai explicit, oferind un nume de fișier și o linie
• - opțiune analiza a fost adăugat la datele de parsare brute ieșire ca JSON din CLI

Ce este nou în versiunea 1.10.6:.

• Asigurați-vă adecvat tip de verificare pentrusee adnotare

Ce este nou în versiunea 1.10.3:.

• requires prevenite la Completare automată dependență de două ori

Ce este nou în versiunea 1.8.0:

• Adăugat capacitatea de a adăuga propriile adnotări la tema
• Fix o problemă cu articolele care sunt comandate în mod aleatoriu

Ce este nou în versiunea 1.6.0:

• Adaugata o Generator Yeoman a face mai ușor de a construi teme.
• Adăugat suport YAML pentru fișiere de configurare; Numele implicit al fișierului de configurare este încă vedea, fie ca .json, .yaml sau .yml.
• Adăugat un mesaj de avertizare împotriva bazându-se pe numele fișierului de configurare implicit (vizualizare. {JSON, YAML, YML}), deoarece se va rupe în versiunea 2.0.0 în favoarea .sassdocrc (care va sprijini atât în ​​format simultan în timp ce fiind mai mult semantic, mai puțin confuz și mai puțin probabil să intre în conflict cu alte proiecte).
• Fixed o problemă în cazul în valoare obiectele variabila "conține o semi-colon.
• îmbunătățit tema lumină (comutare bara laterală mai bine cu statele stocate în localStorage, cod mai bine comutare, mai bine structura JavaScript, și o performanță mai bună).

Ce este nou în versiunea 1.5.2:

• tip implicit Adaugata de substituenți necesare

Ce este nou în versiunea 1.4.1:.

• Fixed un test de spart

Ce este nou în versiunea 1.3.2:.

• Fixed un test de spart

Ce este nou în versiunea 1.1.6:

• Backport, fix găsit-la cu cale absolută.

Cerințe :

• Node.js