# markedify

> Browserify markdown transform.

Latest version **0.0.2** (published 2015-10-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install markedify
pnpm add markedify
yarn add markedify
bun add markedify
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2015-10-21 |
| First published | 2015-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| Author | Minwe |
| Maintainers | minwe |
| Keywords | markdown, browserify, browserify-transform, markdown-transform, marked, js, plugin, transform, highlight.js |

## Links

- npm: https://www.npmjs.com/package/markedify
- Repository: https://github.com/Minwe/markedify
- Issues: https://github.com/Minwe/markedify/issues
- npm.io page: https://npm.io/package/markedify

## Dependencies (4)

- [xtend](https://npm.io/package/xtend.md) ^4.0.0
- [marked](https://npm.io/package/marked.md) ^0.3.5
- [through2](https://npm.io/package/through2.md) ^2.0.0
- [highlight.js](https://npm.io/package/highlight.js.md) ^8.9.1

## 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

- 0.0.2 (latest) — 2015-10-21
- 0.0.1 — 2015-05-30

## README

# markedify

[![Build Status](https://travis-ci.org/Minwe/markedify.svg)](https://travis-ci.org/Minwe/markedify)
[![npm version](https://badge.fury.io/js/markedify.svg)](http://badge.fury.io/js/markedify)

[Browserify](https://github.com/substack/node-browserify) transform for markdown, uses [marked][] as parser and [highlight.js](https://github.com/isagalaev/highlight.js) for code highlighting.

```js
var mdContent = require('path/to/filename.md');

// mdContent is parsed to HTML and stringify, you can use it in your js now.
```

## Installation

```
npm install --save-dev markedfiy
```

## Usage

### CLI

```
browserify main.js -t markedify --outfile bundle.js
```

### Node

```js
var browserify = require('browserify');
var markedify = require('markedify');
var fs = require('fs');

browserify('./main.js', {debug: true})
  .transform(markedify)
  .bundle()
  .on('error', function (err) {console.log('Error: ' + err.message); })
  .pipe(fs.createWriteStream('bundle.js'));
```

### Custom Markdown Renderer

Read [marked docs][marked] for more details.

```js
var browserify = require('browserify');
var markedify = require('markedify');
var fs = require('fs');
var marked = require('marked');
var renderer = new marked.Renderer();
renderer.code = function(code, lang) {
  // highlighting code
  return code;
}

var markedOptions = {
  renderer: renderer,
  gfm: false
};

browserify('./main.js', {debug: true})
  .transform(markedify, {marked: markedOptions})
  .bundle()
  .on('error', function (err) {console.log('Error: ' + err.message); })
  .pipe(fs.createWriteStream('bundle.js'));
```

[marked]:https://github.com/chjj/marked

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