@sankhyalabs/docscss

docscss

docscss é um projeto criado para documentação de variavéis css, tem como principal objetivo gerar um markdown apresentando o nome da varivel e o qual é seu objetivo faz.

Exemplo:

Documentação no CSS.

/*@doc Define a largura do box do checkbox */
--chk--box--width: 18px;
/*@doc Define a altura do box do checkbox */
--chk--box--height: 18px;

Documentação gerada.

CSS Variables

Variable	Description
--chk--box--width	Define a largura do box do checkbox
--chk--box--height	Define a altura do box do checkbox

Como utilizar:

Instalação:

npm install @sankhyalabs/docscss --save-dev

Utilizar como task do gulp:

const {CssDocs} = require('@sankhyalabs/docscss');

gulp.task('css-docs', function () {
    return watch(['src/components/*/*.{css,sass}'], { ignoreInitial: false },   function (vnyl) {
        CssDocs.build(vnyl.path);
    });
});

Utilizar como script do node:

import {CssDocs} from '@sankhyalabs/docscss';
CssDocs.build('src/components/**/*.css');

Funções públicas

Assinatura	Funcionalidades
build(path: string | string[]): void	Essa função recebe uma string ou um Array de strings com o(s) path(s) do(s) arquivos(s) css a serem parseados, essa string pode ser o caminho completo do arquivo, ou com caracteres curingas. Exemplos: "src/components//.{css,sass}", "src/components/**/*.css", src/components/inputs/meuinput.css