SassDoc ble inspirert og modellert etter JSDoc .
Akkurat som alle andre dokumentasjon generator, SassDoc fungerer ved å gripe kommentarer fra SASS / SCSS filer og skape et vakkert, godt organisert HTML-dokumentasjon ut av dem.
Alt innhold er godt strukturert i seksjoner for å håndtere funksjoner, variabler og mixins. Referanser til de opprinnelige kodesnutter og kildekode utheving er også støttet.
I tillegg til standard SassDoc tema, andre maler er også tilgjengelig.
Å bruke SassDoc du sjekke dokumentasjonen først for riktig informasjon om hvordan du formaterer SASS / SCSS kildekode kommentarer slik at de kan oppdages og brukes av SassDoc motor.
Hva er nytt i denne utgaven:
- Oppgrader til Babel 5.0
- Sørg for standard tema navn er riktig logget
- Flere avhengig oppdateringer
- Byttet til ESLint
Hva er nytt i versjon 2.1.1:
- Oppdater sass-konvertere versjon for å hindre 6to5- runtime som beskrives i.
Hva er nytt i versjon 2.0.0:
- Hele API har blitt fullt refactored i ES6
- $ skiltet er nå valgfritt når du definerer navnet iparameter annotering
- Det er nå mulig å bruke fil / mappe eksklusjonsmønsteret
- Det er nå mulig å rør SassDoc inn stdin
- - debug alternativet har blitt lagt til utgang informasjon om nåværende oppsett
- Standard utseende har nå en googleAnalytics konfigurasjon akseptere en Google Analytics-sporingstasten
- Standard utseende har nå en trackingCode konfigurasjon akseptere en vilkårlig HTML-kode for å bli inkludert før & # X3c; / body & # x3e;
- ercontent annotering nå riktig utgang i standard tema
- Standard utseende viser nå den typen samt navnet når kryssbinding elementer (krav, og så videre ...)
- Feilmeldinger skal nå være mer eksplisitt, og gir et filnavn og en linje
- - analysere alternativet er lagt til utgangs rå parsing data som JSON fra CLI
Hva er nytt i versjon 1.10.6:.
- Sørg for riktig type kontroll forsee annotering
Hva er nytt i versjon 1.10.3:.
- forhindretrequires autofylle avhengighet to ganger
Hva er nytt i versjon 1.8.0:
- Lagt evne til å legge til dine egne kommentarer til tema
- Fikset et problem med elementer blir tilfeldig bestilt
Hva er nytt i versjon 1.6.0:
- Lagt til en Yeoman Generator for å gjøre det enklere å bygge temaer.
- Lagd YAML støtte for konfigurasjonsfiler; Standardkonfigurasjonen filnavnet fortsatt vise, enten som .json, .yaml eller .yml.
- Lagt inn en melding for å advare mot å stole på standardkonfigurasjonen filnavnet (vis. {Json, YAML, YML}) siden det vil bryte i versjon 2.0.0 i favør av .sassdocrc (som vil støtte både format på en gang mens være mer semantisk, mindre forvirrende og mindre sannsynlig til konflikt med andre prosjekter).
- Fikset et problem når variable elementer 'verdi inneholder et semikolon.
- Forbedret lyset tema (bedre sidebar veksle med stater som er lagret i localstorage, bedre kode veksle, bedre Javascript-struktur, og bedre ytelse).
Hva er nytt i versjon 1.5.2:
- Lagt implisitt type for nødvendige plassholdere
Hva er nytt i versjon 1.4.1:.
- Fast en ødelagt test
Hva er nytt i versjon 1.3.2:.
- Fast en ødelagt test
Hva er nytt i versjon 1.1.6:
- anvende i en eldre, fast funnet-at med absolutt sti.
Krav :
- Node.js
Kommentarer ikke funnet