# markdown-it-color

> Inline color plugin for markdown-it

Latest version **2.1.1** (published 2021-04-06) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2021-04-06 |
| First published | 2019-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | nkjmsss |
| Maintainers | nkjmsss |
| Keywords | markdown-it, markdown-it-plugin, markdown, color |

## Links

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

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 2.1.1 (latest) — 2021-04-06
- 2.1.0 — 2020-12-12
- 2.0.0 — 2020-08-21
- 1.0.5 — 2019-08-25
- 1.0.4 — 2019-08-25
- 1.0.3 — 2019-08-25
- 1.0.2 — 2019-08-25
- 1.0.1 — 2019-08-25
- 1.0.0 — 2019-04-26

## README

# markdown-it-color

## install

```shell
npm install markdown-it-color --save
```

## use

```javascript
var md = require('markdown-it')()
            .use(require('markdown-it-color'))
```

## API

You can add options. Default option is below.

```javascript
var md = require('markdown-it')()
            .use(require('markdown-it-color'), {
              defaultClassName: 'md-colorify', // default
              inline: false, // default
            })

md.render('{primary}(sample)') // => '<span class="md-colorify md-colorify--primary">sample</span>'
```

If you want to use inline style, use like below.

```javascript
var md = require('markdown-it')()
            .use(require('markdown-it-color'), {
              inline: true,
            })

md.render('{red}(sample)') // => '<span class="md-colorify md-colorify--red" style="color: red;">sample</span>'
```

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