Skip to content

Latest commit

 

History

History
102 lines (78 loc) · 2.26 KB

readme.md

File metadata and controls

102 lines (78 loc) · 2.26 KB
Raw

PLUGIN_NAME

Actions Status NPM Coverage XO code style

Clone this repo and explain what your plugin do and why thousands of people need it ;)

Before:

<html>
  <body>
    <p class="wow">OMG</p>
  </body>
</html>

After:

<svg xmlns="http://www.w3.org/2000/svg">
  <text class="wow" id="wow_id" fill="#4A83B4" fill-rule="evenodd" font-family="Verdana">
    OMG
  </text>
</svg>

Install

Describe how big guys can install your plugin.

npm i PLUGIN_NAME

Usage

Describe how people can use this plugin. Include info about build systems if it's necessary.

const fs = require('fs');
const posthtml = require('posthtml');
const PLUGIN_NAME_CAMEL = require('PLUGIN_NAME');

posthtml()
    .use(PLUGIN_NAME_CAMEL({ /* options */ }))
    .process(html/*, options */)
    .then(result => fs.writeFileSync('./after.html', result.html));

Options

Describe all features of your plugin with examples of usage.

Feature

Before:

<html>
  <body>
    <p>OMG</p>
  </body>
</html>

Add option:

const fs = require('fs');
const posthtml = require('posthtml');
const PLUGIN_NAME_CAMEL = require('PLUGIN_NAME');

posthtml()
    .use(PLUGIN_NAME_CAMEL({ feature: 'wow' }))
    .process(html/*, options */)
    .then(result => fs.writeFileSync('./after.html', result.html));

After:

<html>
  <body>
    <p class="wow">OMG</p>
  </body>
</html>

Contributing

See PostHTML Guidelines and contribution guide.