postcss plugin to generate json file contained code documentation
npm install postcss-docPostCSS plugin to generate a style guide for Air.
CSS comments will be parsed through Markdown and saved in a generated JSON document.
``shell`
$ npm install postcss-doc
Node.js:
`js
var fs = require('fs');
var postcss = require('postcss');
var doc = require('postcss-doc');
var css = fs.readFileSync('input.css', 'utf-8');
var processedCSS = 'output.css';
var options = {
name: "Project name"
};
var output = postcss()
.use(doc(processedCSS, options))
.process(css)
.css;
`
in Gulp:
`js
var gulp = require('gulp');
gulp.task('default', function () {
var postcss = require('gulp-postcss');
var processedCSS = 'output.css';
return gulp.src('src/*.css')
.pipe(postcss([
require('postcss-doc')(processedCSS, {
name: "Project name"
})
]))
.pipe(gulp.dest('build/'));
});
`
To be done!
- options.name`: Project name
The MIT License (MIT)
Copyright (c) 2015 Jan Nahody