Home

Awesome

extract-gfm NPM version

Utilities for extracting and replacing GitHub Flavored Markdown code blocks. For example, you could easily find code blocks for a specific language and run the code through a linter.

See the example for ideas.

Install

Install with npm:

npm i extract-gfm --save-dev

Run tests

npm test

Usage

var extract = require('extract-gfm');
extract.parseBlocks('abc\n```js\nvar foo = "bar";\n```\nxyz');

Returns:

{ text: 'abc\n__CODE_BLOCK0__\nxyz',
  blocks:
   [ { lang: 'js',
       code: 'var foo = "bar";',
       block: '```js\nvar foo = "bar";\n```' } ],
  markers: [ '__CODE_BLOCK0__' ] }

API

.stripBlocks

Strip code blocks from a string and replaced them with heuristic markers.

.extractBlocks

Return an array of all gfm code blocks found. See gfm-code-blocks for more detail.

.parseBlocks

Convenience method to make it easy to replace code blocks.

Returns an object with:

Example

var code = require('extract-gfm');
var fs = require('fs');
var str = fs.readFileSync('README.md', 'utf8');
console.log(code.parseBlocks(str));

.injectBlocks

Used for adding code blocks back into the string after they have been modified somehow.

To customize how this is done, just look at the injectBlocks method and create your own based on this. .parseBlocks() really does all of the hard work.

Author

Jon Schlinkert

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license


This file was generated by verb-cli on September 23, 2014.