SassDoc è stato ispirato e modellato JSDoc .
Esattamente come qualsiasi altro generatore di documentazione, SassDoc opere afferrando i commenti dai file SASS / SCSS e la creazione di una pagina bella, ben organizzato documentazione HTML fuori di essi.
Tutti i contenuti è ben strutturato in sezioni per trattare con le funzioni, variabili e mixins. I riferimenti ai frammenti di codice originale e il codice sorgente evidenziazione è anche supportato.
Oltre al tema standard SassDoc, altri modelli sono disponibili anche.
Per utilizzare SassDoc consultare la relativa documentazione prima per le informazioni appropriate su come formattare SASS / SCSS commenti del codice sorgente in modo che possano essere rilevati e utilizzati da motore di SassDoc.
Cosa c'è di nuovo in questa versione:
- Aggiornamento a Babel 5.0
- Assicurarsi di default nome del tema è correttamente registrato
- Diversi dipendenze
- Switched a ESLint
Aggiornamenti
Cosa c'è di nuovo nella versione 2.1.1:
- Aggiorna versione sass-convert per evitare che il 6to5- problema runtime descritto nella.
Cosa c'è di nuovo nella versione 2.0.0:
- L'intera API è stata completamente riscritta in ES6
- $ segno è ora facoltativo al momento di definire il nome inparameter annotazione
- È ora possibile utilizzare i modelli di esclusione di file / cartelle
- È ora possibile tubo SassDoc in stdin
- - l'opzione di debug è stata aggiunta per inviare informazioni sulla configurazione corrente
- Tema principale ora ha una configurazione googleAnalytics accettare un Google Analytics chiave di monitoraggio
- Tema principale ora ha una configurazione trackingCode accettare un snippet HTML arbitrario da inserire prima & # x3c; / body & # X3e;
- content annotazione è ora trasmesso correttamente in tema di default
- Tema principale ora visualizza il tipo e il nome quando reticolazione articoli (requisiti, e così via ...)
- I messaggi di errore dovrebbero ora essere più esplicito, fornendo un nome di file e una riga
- - opzione analizzare è stata aggiunta ai dati di output di analisi crudo come JSON dalla CLI
Cosa c'è di nuovo in versione 1.10.6:.
- Assicurare controllandosee annotazione corretto tipo
Cosa c'è di nuovo in versione 1.10.3:.
- requires impedito di riempire automaticamente la dipendenza due volte
Cosa c'è di nuovo nella versione 1.8.0:
- Aggiunta la possibilità di aggiungere le proprie annotazioni per il tema
- Risolto un problema con gli oggetti essere ordinato in modo casuale
Cosa c'è di nuovo nella versione 1.6.0:
- Aggiunto un generatore Yeoman per rendere più facile costruire temi.
- Aggiunto il supporto per i file di configurazione YAML; nome del file di configurazione di default è ancora vista, sia come .json, .yaml o .yml.
- Aggiunto un messaggio a mettere in guardia contro basandosi sul nome del file di configurazione di default (vista. {JSON, YAML, yml}) dal momento che si romperà nella versione 2.0.0 in favore di .sassdocrc (che sosterrà sia formato in una sola volta, mentre essendo più semantico, meno confusione e meno probabilità di conflitto con altri progetti).
- Risolto un problema quando il valore di oggetti variabili 'contiene un punto e virgola.
- Migliorato il tema della luce (meglio ginocchiera sidebar con stati memorizzati in localStorage, meglio ginocchiera codice, migliore struttura JavaScript, e migliori prestazioni).
Cosa c'è di nuovo nella versione 1.5.2:
- tipo implicito aggiunto per segnaposto richieste
Cosa c'è di nuovo nella versione 1.4.1:.
- Risolto un test di rotta li>
Cosa c'è di nuovo nella versione 1.3.2:.
- Risolto un test di rotta li>
Cosa c'è di nuovo nella versione 1.1.6:
- Backport, fissato found-in con il percorso assoluto.
Requisiti :
- Node.js
I commenti non trovato