https://github.com/gucong3000/postcss-markdown

PostCSS Syntax for parsing Markdown
https://github.com/gucong3000/postcss-markdown

css html markdown postcss syntax

Last synced: 2 months ago
JSON representation

PostCSS Syntax for parsing Markdown

• Host: GitHub
• URL: https://github.com/gucong3000/postcss-markdown
• Owner: gucong3000
• License: mit
• Created: 2018-04-09T13:33:17.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-11-04T08:20:56.000Z (about 4 years ago)
• Last Synced: 2024-08-03T19:08:21.360Z (4 months ago)
• Topics: css, html, markdown, postcss, syntax
• Language: JavaScript
• Homepage:
• Size: 55.7 KB
• Stars: 21
• Watchers: 4
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-remark - postcss-markdown - Process CSS in markdown. (Built on remark)

README

        
PostCSS Markdown Syntax

====

[![NPM version](https://img.shields.io/npm/v/postcss-markdown.svg?style=flat-square)](https://www.npmjs.com/package/postcss-markdown)

[![Travis](https://img.shields.io/travis/gucong3000/postcss-markdown.svg)](https://travis-ci.org/gucong3000/postcss-markdown)

[![Travis](https://img.shields.io/travis/gucong3000/postcss-syntaxes.svg?label=integration)](https://travis-ci.org/gucong3000/postcss-syntaxes)

[![Codecov](https://img.shields.io/codecov/c/github/gucong3000/postcss-markdown.svg)](https://codecov.io/gh/gucong3000/postcss-markdown)

[![David](https://img.shields.io/david/gucong3000/postcss-markdown.svg)](https://david-dm.org/gucong3000/postcss-markdown)



[PostCSS](https://github.com/postcss/postcss) Syntax for parsing [Markdown](https://daringfireball.net/projects/markdown/syntax)

## 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.

- SCSS: [postcss-scss](https://github.com/postcss/postcss-scss)

- SASS: [postcss-sass](https://github.com/aleshaoleg/postcss-sass)

- LESS: [postcss-less](https://github.com/shellscape/postcss-less)

- SugarSS: [sugarss](https://github.com/postcss/sugarss)

## Use Cases

```js

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:

- SCSS: [postcss-scss](https://github.com/postcss/postcss-scss)

- SASS: [postcss-sass](https://github.com/aleshaoleg/postcss-sass)

- LESS: [postcss-less](https://github.com/shellscape/postcss-less)

- SugarSS: [sugarss](https://github.com/postcss/sugarss)

## Advanced Use Cases

See: [postcss-syntax](https://github.com/gucong3000/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.