gfm-code-blocks's Introduction

gfm-code-blocks

Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string.

Install

Install with npm:

$ npm install --save gfm-code-blocks

Usage

var codeBlocks = require('gfm-code-blocks');
console.log(codeBlocks('usage\n```js\nvar qux = 123;\n```\nxyz'));
//=> {lang: 'js', 
//  code: 'var qux = 123;', 
//  block: '```js\nvar qux = 123;\n```',
//  start: 6,
//  end: 30}

About

Related projects

gfm-code-block-regex: RegExp for gfm (GitHub Flavored Markdown) fenced code blocks. | homepage
markdown-toc: Generate a markdown TOC (table of contents) with Remarkable. | homepage
prettify-markdown: Prettify, format or beautify your markdown. Whatever you want to call it, this does that… more | homepage
remarkable: Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… more | homepage

Contributing

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

Contributors

Commits	Contributor
16	jonschlinkert
3	tunnckoCore

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

This file was generated by verb-generate-readme, v0.4.3, on March 16, 2017.

gfm-code-blocks's People

Contributors

Stargazers

Watchers

gfm-code-blocks's Issues

start and end?

cuz I need them, it is easy to implement and cost nothing (instead eslint-disable-line in my case, lol)

var re = require('gfm-code-block-regex')()

function gfm (str) {
  var arr = []
  var match = null

  while (match = re.exec(str)) { // eslint-disable-line no-cond-assign
    arr.push({
      start: match.index,
      end: match.index + match[1].length,
      lang: match[3],
      code: match[5],
      block: match[1]
    })
  }
  return arr
}
gfm('abc\n```bash\nbar\n```\nxyz')
//=> [ { start: 4,
//    end: 19,
//    lang: 'bash',
//    code: 'bar',
//    block: '```bash\nbar\n```' } ]