RegExp for gfm (GitHub Flavored Markdown) fenced code blocks.
npm install gfm-code-block-regex> RegExp for gfm (GitHub Flavored Markdown) fenced code blocks.
Install with npm:
``sh`
$ npm install --save gfm-code-block-regex
`js
var re = require('gfm-code-block-regex');
var match = re().exec('random text \n`js\nfoo\n`\n more random text');`
console.log(match);
Returns:
`js`
[ 'sh\nnpm install micromatch --save-dev\n`',`
'sh\nnpm install micromatch --save-dev\n`',`
'',`
'sh',
'\nnpm install micromatch --save-dev\n',
'',`
index: 4,
input: 'foo\nsh\nnpm install micromatch --save-dev\n`\nbar' ]`
Note that if a gfm code block has a javascript block comment inside of it, and within the block comment is another gfm code block, it will fail if the block comment does not have leading stars.
Examples
This should work:
`js`
/**
* This is a comment with
* several lines of text.
*
* An example
*
*js`
* var foo = bar;
* var foo = bar;
* var foo = bar;
*`
*/
This will not work (note the absence of leading stars inside the comment):
`js`
/**
This is a comment with
several lines of text.An example
js`
var foo = bar;
var foo = bar;
var foo = bar;
`
*/
Although the previous example is perfectly valid, regex alone is not sufficient.
To generate the readme, run the following command:
`sh`
$ npm install -g verbose/verb#dev verb-generate-readme && verb
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:
`sh``
$ npm install && npm test
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2017, Jon Schlinkert.
Released under the MIT License.
*
_This file was generated by verb-generate-readme, v0.4.3, on March 16, 2017._