SassDoc

SassDoc werd geïnspireerd en gemodelleerd naar JSDoc .
Net als elke andere documentatie generator, SassDoc werkt door grijpen opmerkingen van SASS / SCSS bestanden en het creëren van een mooie, goed georganiseerde HTML-documentatie pagina van hen.
Alle inhoud is goed gestructureerd in secties voor het omgaan met functies, variabelen en mixins. Verwijzingen naar de originele code snippets en source code highlighting wordt ook ondersteund.
Naast de standaard SassDoc thema, andere sjablonen zijn ook beschikbaar.
Om SassDoc gebruiken controleer dan eerst de documentatie voor de juiste informatie over hoe u SASS / SCSS broncode opmerkingen te formatteren, zodat ze kunnen worden gedetecteerd en gebruikt door de motor SassDoc's.

Wat is nieuw in deze release:

• Upgrade naar Babel 5,0
• Zorg ervoor standaardthema naam goed is ingelogd
• Verschillende afhankelijkheden updates
• overschakelde naar ESLint

Wat is nieuw in versie 2.1.1:

• Update-sass-convert-versie om te voorkomen dat de 6to5- runtime probleem dat wordt beschreven in.

Wat is nieuw in versie 2.0.0:

• De hele API is volledig herwerkt in ES6
• $ teken is nu optioneel bij het definiëren van de naam inparameter annotatie
• Het is nu mogelijk om bestanden / mappen uitsluiting patronen gebruiken
• Het is nu mogelijk om pijp SassDoc in stdin
• - debug optie is om de uitvoer van informatie toegevoegd over de huidige setup
• Standaard thema heeft nu een GoogleAnalytics configuratie aanvaarden van een Google Analytics-toets
• Standaard thema heeft nu een trackingcode configuratie accepteren van een willekeurig stukje HTML alvorens te worden opgenomen & # X3c; / body & # x3e;
• content annotatie is nu correct worden weergegeven in standaard thema
• Standaard thema toont nu het type, evenals de naam toen verknoping artikelen (eisen, en zo verder ...)
• Foutmeldingen moet nu meer expliciet, het verstrekken van een bestandsnaam en een lijn
• - ontleden optie is om de productie van ruwe parsing gegevens toegevoegd als JSON uit de CLI

Wat is nieuw in versie 1.10.6:.

• Zorg voor een goede controle van het type voorsee annotatie

Wat is nieuw in versie 1.10.3:.

• Verhinderdrequires om de afhankelijkheid twee keer automatisch te vullen

Wat is nieuw in versie 1.8.0:

• Toegevoegde mogelijkheid om uw eigen aantekeningen toevoegen aan uw thema
• Lost het probleem met items die worden willekeurig besteld

Wat is nieuw in versie 1.6.0:

• Voegde een Yeoman Generator om het gemakkelijker maken om te bouwen thema's.
• Toegevoegde YAML ondersteuning voor configuratiebestanden; standaardconfiguratie bestandsnaam wordt nog wel bekijken, hetzij als .json, .yaml of .yml.
• Toegevoegd een bericht om te waarschuwen tegen een beroep op de standaard configuratie bestand (uitzicht. {Json, YAML, yml}), omdat het in versie 2.0.0 zal breken in het voordeel van .sassdocrc (die zowel formaat zal ondersteunen in een keer, terwijl die meer semantische, minder verwarrend en minder kans op conflicten met andere projecten).
• een probleem opgelost wanneer waarde variabele items 'bevat een puntkomma.
• Verbeterde het licht thema (beter zijbalk toggle met staten opgeslagen in localStorage, betere code toggle, beter JavaScript structuur, en betere prestaties).

Wat is nieuw in versie 1.5.2:

• Toegevoegd impliciete soort voor nodig placeholders

Wat is nieuw in versie 1.4.1:.

• Vast een gebroken-test

Wat is nieuw in versie 1.3.2:.

• Vast een gebroken-test

Wat is nieuw in versie 1.1.6:

• backport, vaste gevonden-op met absolute pad.

Eisen

• Node.js