SassDoc

SassDoc foi inspirado e modelado após JSDoc .
Assim como qualquer outro gerador de documentação, SassDoc funciona agarrando comentários de arquivos SASS / SCSS e criar uma página de documentação HTML bonito, bem organizado fora delas.
Todo o conteúdo é bem estruturado em seções para lidar com funções, variáveis ​​e mixins. Também é suportado remissões para os trechos de código originais e de código-fonte em destaque.
Além do tema SassDoc standard, outros modelos também estão disponíveis.
Para usar SassDoc por favor, verifique primeiro sua documentação para a informação adequada sobre como formatar SASS / SCSS comentários de código fonte para que eles possam ser detectados e usado pelo motor de SassDoc.

O que é novo nesta versão:

• Upgrade para Babel 5.0
• Certifique-padrão nome do tema está devidamente registrado

Atualizações
• várias dependências
• Comutado para ESLint

O que é novo na versão 2.1.1:

• Actualizar versão sass-convertido para evitar que o 6to5- questão de tempo de execução descrito no.

O que é novo na versão 2.0.0:

• Toda a API foi totalmente reformulado em ES6
• $ sinal agora é opcional ao definir o nome na anotaçãoParameter
• Agora é possível usar os padrões de exclusão de arquivos / pastas
• Agora é possível SassDoc tubo em stdin
• - opção de depuração foi adicionado à saída informações sobre a configuração atual
• Tema Padrão agora tem uma configuração GoogleAnalytics aceitar um Google Analytics chave tracking
• Tema Padrão agora tem uma configuração trackingCode aceita um trecho de HTML arbitrário para ser incluído antes de & # X3C; / body & # x3e;
• anotaçãocontent é agora corretamente saída em tema padrão
• Tema Padrão agora exibe o tipo, bem como o nome quando cross-linking itens (requisitos, e assim por diante ...)
• As mensagens de erro agora deve ser mais explícita, fornecendo um nome de arquivo e uma linha
• - opção analisar foi adicionado aos dados de saída de análise crua como JSON do CLI

O que é novo na versão 1.10.6:.

• Certifique-se de tipo adequado verificandosee anotação

O que é novo na versão 1.10.3:.

• requires impedidos de preencher automaticamente dependência duas vezes

O que é novo na versão 1.8.0:

• Adicionado a capacidade de adicionar suas próprias anotações para seu tema
• Corrigido um problema com os itens a serem ordenados aleatoriamente

O que é novo na versão 1.6.0:

• Adicionado um Generator Yeoman para torná-lo mais fácil de construir temas.
• Adicionado suporte para arquivos de configuração YAML; Nome do arquivo de configuração padrão ainda é ver, seja como .json, .yaml ou .yml.
• Adicionado uma mensagem para alertar contra contando com o nome do arquivo de configuração padrão (view. {Json, yaml, yml}), uma vez que vai quebrar na versão 2.0.0 em favor de .sassdocrc (que apoiará tanto formato de uma só vez, enquanto sendo mais semântica, menos confuso e menos propensos a conflitos com outros projetos).
• Corrigido um problema quando o valor dos itens variável contém um ponto e vírgula.
• Melhorado o tema luz (melhor alternar barra lateral com estados armazenados em localStorage, melhor alternância de código, melhor estrutura de JavaScript, e melhor performance).

O que é novo na versão 1.5.2:

• tipo implícito Adicionado por espaços reservados necessários

O que é novo na versão 1.4.1:.

• Corrigido um teste quebrado

O que é novo na versão 1.3.2:.

• Corrigido um teste quebrado

O que é novo na versão 1.1.6:

• Backport, fixo encontrou-a com caminho absoluto.

Requisitos :

• Node.js