SassDoc įkvėpė ir modeliuojama po JSDoc .
Tiesiog kaip ir bet kurios kitos dokumentacijos generatorius, SassDoc veikia greiferiniai komentarus SASS / SCSS failus ir sukurti gražus, gerai organizuota HTML dokumentus puslapį iš jų.
Visas turinys yra gerai struktūriškai į sekcijas sprendžiant funkcijų, kintamųjų ir mixins. Nuorodos į originalų kodą fragmentus ir kodo išryškinimas taip pat pritarė.
Be standartinio SassDoc tema, kiti šablonai yra taip pat prieinama.
Norėdami naudoti SassDoc patikrinkite savo dokumentus pirmąjį atitinkama informacija apie tai, kaip formatuoti SASS / SCSS šaltinio kodą komentarų, todėl jie gali būti aptinkami ir naudojami SassDoc variklį.
Kas naujo šioje versijoje:
- Atnaujinti Babelio 5.0
- Įsitikinkite Įprasta tema vardas yra tinkamai prisijungęs
- Keletas priklausomos atnaujinimai
- Jungiamas ESLint
Kas naujo versijos 2.1.1:
- Atnaujinti Sass-konvertuoti versija išvengti 6to5- Runtime problema aprašyta.
Kas naujo versijos 2.0.0:
- Visa API buvo visiškai išimant iš ES6
- $ ženklas dabar neprivaloma apibrėždama vardąparameter anotacija
- Tai dabar galima naudoti failo / aplanko atskirties modelius
- Tai dabar galima vamzdžio SassDoc į STDIN
- - derinimo galimybė buvo įtraukta į išvesties informacijai apie dabartinę setup
- Numatytasis tema dabar turi googleanalytics konfigūraciją priimdamas Google Analytics "stebėjimo raktą
- Numatytasis tema dabar turi trackingCode konfigūraciją, priimantį savavališkai HTML fragmentą būti įtraukti iki & # x3c / body & # x3e;
- content anotacija dabar teisingai produkcijos numatytąją temą
- Numatytasis tema dabar rodo tipo, taip pat vardu, kai skersiniams elementus (reikalavimus, ir tt ...)
- Klaidų pranešimai dabar turėtų būti aiškiau, suteikiant rinkmenos pavadinimą ir linija
- - išanalizuoti galimybę buvo įtraukta į produkcijos žaliavos sintaksės analizės duomenimis JSON iš CLI
Kas naujo versija 1.10.6:.
- Užtikrinti tinkamą tipą tikrintisee anotacija
Kas naujo versija 1.10.3:.
- neleidorequires perrašyti priklausomybę du kartus
Kas naujo versijos 1.8.0:
- Pridėta galimybė pridėti savo komentarus prie jūsų temos
- Fiksuotas su daiktais klausimas buvo atsitiktinai užsisakyti
Kas naujo versijos 1.6.0:
- Pridėta Yeoman generatorius, kad būtų lengviau kurti temos.
- Pridėta yaml parama konfigūracijos failus; numatytoji konfigūracija failo pavadinimas yra vis dar mano, arba kaip .json, .yaml ar .yml.
- Pridėta žinutę įspėja remdamasi numatytoji konfigūracija failo pavadinimą (vaizdas. {JSON, yaml, YML}), nes tai bus pertrauka versijos 2.0.0 naudai .sassdocrc (kuris rems formatą iš karto, o yra daugiau semantinio mažiau paini ir mažiau tikėtina, kad konflikto su kitais projektais).
- Fiksuotas problema, kai kintamos straipsniai "vertė yra kabliataškį.
- Geresnis šviesos tema (geriau parankinės Toggle su saugomais vietinę saugyklą valstybių, geriau kodas perjungti, geriau JavaScript struktūra ir geresnių rezultatų).
Kas naujo Versija 1.5.2:
- Pridėta numanoma tipas reikalingų rezervuotų
Kas naujo 1.4.1 versijoje:.
- Fiksuotas skaldyti testas
Kas naujo versijos 1.3.2:.
- Fiksuotas skaldyti testas
Kas naujo 1.1.6 versija:
- Backport, fiksuoto rasti-ne su absoliučiu keliu.
Reikalavimai :
- Node.js
Komentarai nerastas