Home

Awesome

snapdragon-cheerio NPM version NPM monthly downloads NPM total downloads Linux Build Status

Snapdragon plugin for converting a cheerio AST to a snapdragon AST.

Install

Install with npm:

$ npm install --save snapdragon-cheerio

Usage

Use the .parse method directly to return an AST:

var snapdragonCheerio = require('snapdragon-cheerio');
var ast = snapdragonCheerio.parse('<strong>It worked!</strong>');
console.log(ast);
// Node {
//   type: 'string',
//   nodes:
//    [ Node { type: 'bos', val: '', index: 0 },
//      Node { type: 'strong', attribs: {}, index: 1, nodes: [Object] },
//      Node { type: 'eos', val: '', index: 2 } ] }

Snapdragon plugin usage

Pass to snapdragon's .use method to use as a plugin:

var snapdragonCheerio = require('snapdragon-cheerio');
var Snapdragon = require('snapdragon');
var snapdragon = new Snapdragon();
snapdragon.use(snapdragonCheerio());

var ast = snapdragon.parse('<strong>It worked!</strong>');
// Node {
//   type: 'string',
//   nodes:
//    [ Node { type: 'bos', val: '', index: 0 },
//      Node { type: 'strong', attribs: {}, index: 1, nodes: [Object] },
//      Node { type: 'eos', val: '', index: 2 } ] }

Visit snapdragon to learn how to compile the generated AST into a string.

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. MIT


This file was generated by verb-generate-readme, v0.4.2, on February 15, 2017.