SassDoc byla inspirována a po vzoru JSDoc .
Stejně jako každý jiný generátor dokumentace, SassDoc funguje tak, že chytne připomínky SASS / SCSS soubory a vytvářet krásné, dobře organizovaný stránky HTML dokumentaci z nich.
Veškerý obsah je dobře strukturován do sekcí pro práci s funkcemi, proměnné a mixins. Je také podporována Odkazy na původní úryvky kódu a zdrojového kódu zvýraznění.
Kromě standardního SassDoc téma, jiné šablony jsou také k dispozici.
Chcete-li používat SassDoc zkontrolujte jeho dokumentaci nejprve dostatečně informováni o tom, jak formátovat SASS / SCSS zdrojového kódu připomínky, aby mohly být detekovány a použity motorem SassDoc je.
Co je nového V této verzi:
- Upgrade na Babel 5.0
- Ujistěte se, výchozí název téma je řádně přihlášen
- Několik závislostí
- Přepnutím do ESLint
Aktualizace
Co je nového ve verzi 2.1.1:
- Aktualizace Sass-convert verze, aby se zabránilo 6to5- runtime problém popsaný v.
Co je nového ve verzi 2.0.0:
- Celá API byl zcela přepracován v ES6
- $ značka je nyní nepovinný při definování názvu vparameter anotaci
- Nyní je možné použít vyloučení souborů / složek vzory
- Nyní je možné, aby potrubí SassDoc do standardního vstupu
- - možnost ladění byla přidána do výstupních informací o aktuálním nastavení
- Default téma má nyní konfiguraci googleAnalytics souhlasí s Google Analytics sledování tlačítka
- Default téma má nyní konfiguraci trackingCode přijímá libovolný HTML úryvek které mají být zahrnuty do & # x3c; / body & # x3e,
- content anotace je nyní správně výstup výchozí motiv
- Default téma nyní zobrazuje typ, stejně jako jméno při cross-propojování předmětů (požadavky, a tak dále ...)
- Chybová hlášení by nyní mělo být jasnější, poskytuje název souboru a řádek
- - možnost analyzovat byl přidán do vyprodukovat surový analýzu dat jako JSON z CLI
Co je nového ve verzi 1.10.6:.
- Zkontrolujte, zda kontrola prosee anotaci vhodný typ
Co je nového ve verzi 1.10.3:.
- zabránilarequires dvakrát automaticky vyplnit závislost
Co je nového ve verzi 1.8.0:
- Přidána možnost přidat své vlastní poznámky k motivu
- Opraven problém s položek, které jsou náhodně seřazené
Co je nového ve verzi 1.6.0:
- Přidáno Yeoman generátor, aby bylo jednodušší postavit themes.
- Přidána podpora YAML konfigurační soubory; výchozí název konfiguračního souboru je ještě mohli, ať už jako .json, .yaml nebo .yml.
- Přidáno zprávu varovat před spoléhat na výchozí název konfiguračního souboru (pohled. {JSON, YAML, YML}), protože se zlomí ve verzi 2.0.0 ve prospěch .sassdocrc (který bude podporovat jak ve formátu najednou, zatímco je více sémantická, méně matoucí a méně pravděpodobné, že v rozporu s jinými projekty).
- Opraven problém, když hodnota proměnná položek "obsahuje středník.
- Lepší světlo téma (lepší sidebar přepínač se státy uloženými v localStorage, lépe kód přepínač, lepší struktura JavaScript, a lepší výkon).
Co je nového ve verzi 1.5.2:
- Přidána implicitní typ pro požadované zástupné symboly
Co je nového ve verzi 1.4.1:.
- Pevná zlomený zkouška
Co je nového ve verzi 1.3.2:.
- Pevná zlomený zkouška
Co je nového ve verzi 1.1.6:
- portovat, pevné našel-at s absolutní cestou.
Požadavky na :
- Node.js
Komentáře nebyl nalezen