Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/regexhq/gfm-code-block-regex
RegExp for gfm (GitHub Flavored Markdown) code blocks.
https://github.com/regexhq/gfm-code-block-regex
gfm github-flavored-markdown markdown regex regular-expression
Last synced: 27 days ago
JSON representation
RegExp for gfm (GitHub Flavored Markdown) code blocks.
- Host: GitHub
- URL: https://github.com/regexhq/gfm-code-block-regex
- Owner: regexhq
- License: mit
- Created: 2014-08-13T08:49:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-16T15:39:58.000Z (over 7 years ago)
- Last Synced: 2024-10-09T16:20:01.362Z (about 1 month ago)
- Topics: gfm, github-flavored-markdown, markdown, regex, regular-expression
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 17.6 KB
- Stars: 13
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gfm-code-block-regex [](https://www.npmjs.com/package/gfm-code-block-regex) [](https://npmjs.org/package/gfm-code-block-regex) [](https://npmjs.org/package/gfm-code-block-regex) [](https://travis-ci.org/regexhq/gfm-code-block-regex)
> RegExp for gfm (GitHub Flavored Markdown) fenced code blocks.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save gfm-code-block-regex
```
## Usage
```js
var re = require('gfm-code-block-regex');
var match = re().exec('foo\n```sh\nnpm install micromatch --save-dev\n```\nbar');
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\n```sh\nnpm install micromatch --save-dev\n```\nbar' ]
```
## Heads up!
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.
## About
### Related projects
- [extract-gfm](https://www.npmjs.com/package/extract-gfm): Utilities for extracting and replacing GitHub Flavored Markdown code blocks. For example, you could easily… [more](https://github.com/jonschlinkert/extract-gfm) | [homepage](https://github.com/jonschlinkert/extract-gfm "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.")
- [gfm-code-blocks](https://www.npmjs.com/package/gfm-code-blocks): Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string. | [homepage](https://github.com/jonschlinkert/gfm-code-blocks "Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string.")
- [to-gfm-code-block](https://www.npmjs.com/package/to-gfm-code-block): Generate a github-flavored-markdown fenced-code-block snippet. | [homepage](https://github.com/jonschlinkert/to-gfm-code-block "Generate a github-flavored-markdown fenced-code-block snippet.")
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
### Contributors
### Release history
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ 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:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on March 16, 2017._