gfm-code-block-regex

WebJar for gfm-code-block-regex

License	MIT
GroupId	org.webjars.npm
ArtifactId	gfm-code-block-regex
Last Version	0.2.1
Release Date	Nov 10, 2017
Type	jar
Description	gfm-code-block-regex WebJar for gfm-code-block-regex
Project URL	http://webjars.org
Source Code Management	https://github.com/regexhq/gfm-code-block-regex

Download gfm-code-block-regex

Filename	Size
gfm-code-block-regex-0.2.1.pom
gfm-code-block-regex-0.2.1.jar	8 KB
gfm-code-block-regex-0.2.1-sources.jar	22 bytes
gfm-code-block-regex-0.2.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/gfm-code-block-regex/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>gfm-code-block-regex</artifactId>
    <version>0.2.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/gfm-code-block-regex/
implementation 'org.webjars.npm:gfm-code-block-regex:0.2.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/gfm-code-block-regex/
implementation ("org.webjars.npm:gfm-code-block-regex:0.2.1")

Apache Buildr

'org.webjars.npm:gfm-code-block-regex:jar:0.2.1'

Apache Ivy

<dependency org="org.webjars.npm" name="gfm-code-block-regex" rev="0.2.1">
  <artifact name="gfm-code-block-regex" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='gfm-code-block-regex', version='0.2.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "gfm-code-block-regex" % "0.2.1"

Leiningen

[org.webjars.npm/gfm-code-block-regex "0.2.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

gfm-code-block-regex

RegExp for gfm (GitHub Flavored Markdown) fenced code blocks.

Install

Install with npm:

$ npm install --save gfm-code-block-regex

Usage

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:

[ '```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: Utilities for extracting and replacing GitHub Flavored Markdown code blocks. For example, you could easily… more | homepage
• gfm-code-blocks: Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string. | homepage
• to-gfm-code-block: Generate a github-flavored-markdown fenced-code-block snippet. | homepage

Contributing

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

Contributors

Release history

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

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

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

RegexHQ

Collaboration on a world-wide community-driven collection of RegExp patterns and tools that can make our life easier.

Versions

Version
0.2.1 Nov 10, 2017