gucong3000 / postcss-markdown

PostCSS Syntax for parsing Markdown
MIT License
21 stars 10 forks source link
css html markdown postcss syntax

PostCSS Markdown Syntax

NPM version Travis Travis Codecov David

<img align="right" width="95" height="95" title="Philosopher’s stone, logo of PostCSS" src="http://postcss.github.io/postcss/logo.svg">

PostCSS Syntax for parsing Markdown

Getting Started

First thing's first, install the module:

npm install postcss-syntax postcss-markdown --save-dev

If you want support SCSS/SASS/LESS/SugarSS syntax, you need to install the corresponding module.

Use Cases

var syntax = require('postcss-syntax')({
    // Enable support for HTML (default: true) See: https://github.com/gucong3000/postcss-html
    htmlInMd: true,
    // syntax for parse scss (non-required options)
    scss: require('postcss-scss'),
    // syntax for parse less (non-required options)
    less: require('postcss-less'),
    // syntax for parse css blocks (non-required options)
    css: require('postcss-safe-parser'),
});
var autoprefixer = require('autoprefixer');
postcss([ autoprefixer ]).process(source, { syntax: syntax }).then(function (result) {
    // An alias for the result.css property. Use it with syntaxes that generate non-CSS output.
    result.content
});

input:

# title

```css
::placeholder {
    color: gray;
}
```

output:

# title

```css
::-webkit-input-placeholder {
    color: gray;
}
:-ms-input-placeholder {
    color: gray;
}
::-ms-input-placeholder {
    color: gray;
}
::placeholder {
    color: gray;
}
```

If you want support SCSS/SASS/LESS/SugarSS syntax, you need to install these module:

Advanced Use Cases

See: postcss-syntax

Style Transformations

The main use case of this plugin is apply PostCSS transformations to CSS (and CSS-like) code blocks in markdown file.