# gulp-marked-json

> Parse Markdown YAML meta data and- compile Markdown to HTML, wrap it all up in JSON.

Latest version **1.1.0** (published 2018-01-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-marked-json
pnpm add gulp-marked-json
yarn add gulp-marked-json
bun add gulp-marked-json
```

## 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.0 |
| Published | 2018-01-06 |
| First published | 2016-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | minwe |
| Maintainers | minwe |
| Keywords | gulp, gulpplugin, markdown, yaml, marked, frontmatter, json, markit |

## Links

- npm: https://www.npmjs.com/package/gulp-marked-json
- Repository: https://github.com/minwe/gulp-marked-json
- Homepage: https://github.com/minwe/gulp-marked-json#readme
- Issues: https://github.com/minwe/gulp-marked-json/issues
- npm.io page: https://npm.io/package/gulp-marked-json

## Dependencies (4)

- [marked](https://npm.io/package/marked.md) ^0.3.5
- [through2](https://npm.io/package/through2.md) ^2.0.1
- [front-matter](https://npm.io/package/front-matter.md) ^2.0.7
- [plugin-error](https://npm.io/package/plugin-error.md) ^0.1.2

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.0 (latest) — 2018-01-06
- 1.0.0 — 2016-04-28

## README

# gulp-marked-json

[![NPM version](https://img.shields.io/npm/v/gulp-marked-json.svg?style=flat-square)](https://www.npmjs.com/package/gulp-marked-json)
[![Build Status](https://img.shields.io/travis/minwe/gulp-marked-json.svg?style=flat-square)](https://travis-ci.org/minwe/gulp-marked-json)
[![Dependency Status](https://img.shields.io/david/minwe/gulp-marked-json.svg?style=flat-square)](https://david-dm.org/minwe/gulp-marked-json)
[![devDependency Status](https://img.shields.io/david/dev/minwe/gulp-marked-json.svg?style=flat-square)](https://david-dm.org/minwe/gulp-marked-json#info=devDependencies)

- Parse YAML front matter and Markdown body content with [front-matter][front-matter]
- Compile Markdown to HTML with [marked][marked]

### Install

```bash
$ npm install gulp-marked-json --save-dev
```

### Usage

Like any self-respecting gulp plugin, transformed source files will flow onward to the destination of your choice with directory structure preserved. Tinker with [marked’s config][marked-config] by passing an object.

**`gulpfile.js`**

```javascript
var gulp = require('gulp');
var markdown = require('gulp-marked-json');

gulp.task('markdown', function(){
  gulp.src('./content/**/*.md')
    .pipe(markdown({
        pedantic: true,
        smartypants: true
    }))
    .pipe(gulp.dest('.'));
});
```

**`/blog/posts/bushwick-artisan.md`**

    slug: bushwick-artisan
    title: Wes Anderson pop-up Bushwick artisan
    layout: centered
    ---

    ## YOLO
    Chia quinoa meh, you probably haven't heard of them sartorial Holowaychuk pickled post-ironic. Plaid ugh vegan, Sixpoint 8-bit sartorial artisan semiotics put a bird on it Mission bicycle rights Club-Mate vinyl.

**`/blog/posts/bushwick-artisan.json`**

```json
{
  "slug": "bushwick-artisan",
  "title": "Wes Anderson pop-up Bushwick artisan",
  "layout": "centered",
  "body": "<h2 id="yolo">YOLO</h2>\n<p>Chia quinoa meh, you probably haven't heard of them sartorial Holowaychuk pickled post-ironic. Plaid ugh vegan, Sixpoint 8-bit sartorial artisan semiotics put a bird on it Mission bicycle rights Club-Mate vinyl.</p>"
}
```

----
**[MIT](LICENSE) LICENSE** <br>
copyright &copy; 2014 sparkart group, inc.

[gulp-util]: https://github.com/gulpjs/gulp-util#buffercb
[front-matter]: https://github.com/jxson/front-matter
[marked]: https://github.com/chjj/marked
[marked-config]: https://github.com/lepture/markit#usage
[handlebars]: https://github.com/wycats/handlebars.js
[circleci]: https://circleci.com/gh/SparkartGroupInc/gulp-markdown-to-json.png?style=shield&circle-token=8bf33da398b8ab296fe670c81b3fecbae1471e25

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