A Metalsmith plugin for PostCSS.
Use PostCSS and PostCSS plugins with Metalsmith.
You mustn't forget to install the PostCSS plugins with npm install first.
npm install metalsmith-with-postcss --save
metalsmith.json config example:
{
"plugins": {
"metalsmith-with-postcss": {
pattern: ['**/*.css', '!**/_*/*', '!**/_*'], //This is the default.
plugins: {
'postcss-import': {},
'postcss-if-media': {},
'postcss-custom-media': {},
'postcss-media-minmax': {},
'postcss-layout': {},
'postcss-aspect-ratio': {},
'autoprefixer': {}
}
}
}
}Build script example:
var metalsmith = require('metalsmith');
var markdown = require('metalsmith-markdown');
var postcss = require('metalsmith-with-postcss');
var sugarss = require('sugarss');
var rename = require('metalsmith-rename';
metalsmith(__dirname)
.source('src')
.destination('pub')
.use(postcss({
pattern: ['**/*.sss', '!**/_*/*', '!**/_*'], //For SugarSS,
parser: sugarss,
plugins: {
'postcss-import': {},
'postcss-if-media': {},
'postcss-custom-media': {},
'postcss-media-minmax': {},
'postcss-layout': {},
'postcss-aspect-ratio': {},
'autoprefixer': {}
}
}))
.use(rename([[/\.sss$/, '.css']])) //Renames processed files to CSS
.use(markdown({
gfm: true,
tables: true
}))
.build(function (err) {
if (err) {
throw err;
}
});
| Option | Default Value | Description |
|---|---|---|
pattern |
['**/*.css', '!**/_*/*', '!**/_*'] |
Only process files that match this pattern, can be an array of multiple patterns, following multimatch rules. The default patterns exclude any files or folders prefixed with an underscore. |
parser |
undefined |
A custom parser module passed directly to PostCSS. |
stringifier |
undefined |
A custom stringifier module passed directly to PostCSS. |
syntax |
undefined |
A shorthand object for the parser and stringifier passed directly to PostCSS. |
plugins |
{} |
A collection of plugin module names as keys and any options for them as values. |
map |
{inline: true} |
Source mapping options passed directly to PostCSS. |
removeExcluded |
false |
If true, remove the files from metalsmith that were excluded by the pattern, so they won't appear in your build directory. |