# jstransformer-markdown-it

> markdown-it support for JSTransformers.

Latest version **3.0.0** (published 2022-07-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install jstransformer-markdown-it
pnpm add jstransformer-markdown-it
yarn add jstransformer-markdown-it
bun add jstransformer-markdown-it
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2022-07-19 |
| First published | 2015-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=7 |
| Dependencies | 1 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 25 |
| Author | JSTransformers Team |
| Maintainers | robloach, forbeslindesay, stoeffel, hemanth, timothygu, calebeby |
| Keywords | jstransformer, markdown-it |

## Links

- npm: https://www.npmjs.com/package/jstransformer-markdown-it
- Repository: https://github.com/jstransformers/jstransformer-markdown-it
- Homepage: https://github.com/jstransformers/jstransformer-markdown-it#readme
- Issues: https://github.com/jstransformers/jstransformer-markdown-it/issues
- npm.io page: https://npm.io/package/jstransformer-markdown-it

## Dependencies (1)

- [markdown-it](https://npm.io/package/markdown-it.md) ^13.0.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2022-07-19
- 2.1.0 — 2018-04-23
- 2.0.0 — 2016-10-19
- 1.0.0 — 2016-08-24
- 0.2.3 — 2016-04-03
- 0.2.2 — 2015-10-16
- 0.2.1 — 2015-10-16
- 0.2.0 — 2015-10-16
- 0.1.0 — 2015-07-03
- 0.0.2 — 2015-03-29
- 0.0.1 — 2015-02-18

## README

# jstransformer-markdown-it

[markdown-it](https://github.com/markdown-it/markdown-it) support for [JSTransformers](http://github.com/jstransformers).

[![Build Status](https://img.shields.io/travis/jstransformers/jstransformer-markdown-it/master.svg)](https://travis-ci.org/jstransformers/jstransformer-markdown-it)
[![Coverage Status](https://img.shields.io/codecov/c/github/jstransformers/jstransformer-markdown-it/master.svg)](https://codecov.io/gh/jstransformers/jstransformer-markdown-it)
[![Dependency Status](https://img.shields.io/david/jstransformers/jstransformer-markdown-it/master.svg)](http://david-dm.org/jstransformers/jstransformer-markdown-it)
[![NPM version](https://img.shields.io/npm/v/jstransformer-markdown-it.svg)](https://www.npmjs.org/package/jstransformer-markdown-it)

## Installation

    npm install jstransformer-markdown-it

## API

```js
var md = require('jstransformer')(require('jstransformer-markdown-it'));

md.render('# Hello World!').body;
//=> '<h1>Hello World!</h1>'
```

### Inline rendering

markdown-it supports rendering a Markdown string in an inline fashion (i.e. without wrapping `<p>`):

```js
var md = require('markdown-it')();
md.renderInline(src);
```

In jstransformer-markdown-it, this can be achieved through the `inline` option:

```js
var md = require('jstransformer')(require('jstransformer-markdown-it'));
md.render('**strong**').body;
//=> '<p><strong>strong</strong></p>\n'
md.render('**strong**', { inline: true }).body;
//=> '<strong>strong</strong>'
```

### Plugins

Plugins in markdown-it are applied with the `.use` function:

```js
var md = require('markdown-it')();
md.use(require('plugin1'));
md.use(plugin2);
md.use(plugin3, opts, ...);
md.use(require('plugin4'), opts, ...);
```

jstransformer-markdown-it allows doing the same through the `plugins` option:

```js
var md = require('jstransformer')(require('jstransformer-markdown-it'));

md.render(markdown, {
  plugins: [
    'plugin1',
    plugin2,
    [plugin3, opts, ...],
    ['plugin4', opts, ...]
  ]
}).body;
```

If an element of the `plugins` array is a string, it is `require`d. If an element is an array, the first element will represent the plugin, while the rest are treated as options to that plugin.

### Rules

markdown-it allows enabling and disabling specific rules through `md.disable` and `.enable` functions:

```js
var md = require('markdown-it')();
md.disable([ 'link', 'image' ]);
md.disable('backticks');
md.disable('might-not-exist', true);
md.enable('might-not-exist2', true);
```

In jstransformer-markdown-it, the same thing can be done with the `enable` and `disable` options, with slightly modified syntax:

```js
var md = require('jstransformer')(require('jstransformer-markdown-it'))

md.render(markdown, {
  disable: [
    'link',
    'image',
    'backticks',
    ['might-not-exist', true]
  ],
  enable: [
    ['might-not-exist2', true]
  ]
}).body;
```

## License

MIT

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