https://github.com/posthtml/posthtml-velocity
Velocity
https://github.com/posthtml/posthtml-velocity
Last synced: 8 months ago
JSON representation
Velocity
- Host: GitHub
- URL: https://github.com/posthtml/posthtml-velocity
- Owner: posthtml
- License: mit
- Created: 2020-05-09T14:26:09.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T05:24:55.000Z (about 3 years ago)
- Last Synced: 2025-07-28T12:44:56.521Z (8 months ago)
- Language: JavaScript
- Size: 1.11 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license
Awesome Lists containing this project
README
# PostHTML Velocity 
[![NPM][npm]][npm-url]
[![Deps][deps]][deps-url]
[![Build][build]][build-badge]
[![Coverage][cover]][cover-badge]
[![Standard Code Style][style]][style-url]
Clone this repo and explain what your plugin do and why thousands of people need it ;)
Before:
``` html
OMG
```
After:
``` html
OMG
```
## Install
Describe how big guys can install your plugin.
> npm i posthtml posthtml-plugin
## Usage
Describe how people can use this plugin. Include info about build systems if it's
necessary.
``` js
const fs = require('fs');
const posthtml = require('posthtml');
const velocity = require('posthtml-velocity');
posthtml()
.use(velocity({ /* 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
OMG
```
Add option:
``` js
const fs = require('fs');
const posthtml = require('posthtml');
const velocity = require('posthtml-velocity');
posthtml()
.use(velocity({ feature: 'wow' }))
.process(html/*, options */)
.then(result => fs.writeFileSync('./after.html', result.html));
```
After:
``` html
OMG
```
### Contributing
See [PostHTML Guidelines](https://github.com/posthtml/posthtml/tree/master/docs) and [contribution guide](CONTRIBUTING.md).
### License [MIT](LICENSE)
[npm]: https://img.shields.io/npm/v/posthtml-velocity.svg
[npm-url]: https://npmjs.com/package/posthtml-velocity
[deps]: https://david-dm.org/posthtml/posthtml-velocity.svg
[deps-url]: https://david-dm.org/posthtml/posthtml-velocity
[style]: https://img.shields.io/badge/code%20style-standard-yellow.svg
[style-url]: http://standardjs.com/
[build]: https://travis-ci.org/posthtml-velocity/posthtml-velocity.svg?branch=master
[build-badge]: https://travis-ci.org/posthtml-velocity/posthtml-velocity?branch=master
[cover]: https://coveralls.io/repos/posthtml-velocity/posthtml-velocity/badge.svg?branch=master
[cover-badge]: https://coveralls.io/r/posthtml-velocity/posthtml-velocity?branch=master