# gulp-markdown-code-blocks

> Gulp task for running markdown-code-blocks.

Latest version **1.1.1** (published 2016-08-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-markdown-code-blocks
pnpm add gulp-markdown-code-blocks
yarn add gulp-markdown-code-blocks
bun add gulp-markdown-code-blocks
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2016-08-11 |
| First published | 2014-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Sascha Depold |
| Maintainers | sdepold |
| Keywords | gulp, markdown-code-blocks |

## Links

- npm: https://www.npmjs.com/package/gulp-markdown-code-blocks
- Repository: https://github.com/sdepold/gulp-markdown-code-blocks
- Issues: https://github.com/sdepold/gulp-markdown-code-blocks/issues
- npm.io page: https://npm.io/package/gulp-markdown-code-blocks

## Dependencies (4)

- [resolve](https://npm.io/package/resolve.md) ^1.0.0
- [through2](https://npm.io/package/through2.md) ^0.6.3
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.1
- [markdown-code-blocks](https://npm.io/package/markdown-code-blocks.md) 0.0.1

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.1.1 (latest) — 2016-08-11
- 1.1.0 — 2015-01-07
- 1.0.2 — 2014-11-03
- 1.0.1 — 2014-11-03
- 1.0.0 — 2014-10-27

## README

# gulp-markdown-code-blocks [![Build Status](https://secure.travis-ci.org/sdepold/gulp-markdown-code-blocks.png)](http://travis-ci.org/sdepold/gulp-markdown-code-blocks)

Gulp task for running [markdown-code-blocks](https://github.com/grncdr/markdown-code-blocks).

## Installation

```
npm install --save-dev gulp gulp-markdown-code-blocks markdown-code-blocks
```

## Usage

Evaluating the code of your readme file is as easy as this:

```javascript
'use strict';

var gulp    = require('gulp');
var mdBlock = require('gulp-markdown-code-blocks');

gulp.task('default', function () {
  return gulp.src('./README.md').pipe(mdBlock());
});
```

## Niceties

Please note that the previous snippet is a code fence, that is evaluated by the code block parser as
well. That means it will try to evaluate `require('gulp-markdown-code-blocks')`, a.k.a. it will try
to resolve the name of this project, which is not part of the `package.json` file. Before throwing
the readme file into `markdown-code-blocks`, the gulp task try to find your `package.json` in the
same directory as the readme file and replace `require('name-of-your-package')` with `require('value-of-the-main-property-of-your-package-json')`. So in case of this lib, it will actually
be `require('./index.js')`.

## Test

The following snippet will be executed and evaluated:

```javascript
require('assert')(true);
```

## License

MIT

---
_Source: https://npm.io/package/gulp-markdown-code-blocks · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._