# markdown-it-special-terms

> Plugin to add custom parsing for text contained in {curly} braces.

Latest version **1.1.1** (published 2018-06-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install markdown-it-special-terms
pnpm add markdown-it-special-terms
yarn add markdown-it-special-terms
bun add markdown-it-special-terms
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2018-06-13 |
| First published | 2018-01-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Dan Behlings |
| Maintainers | nevenall |
| Keywords | markdown-it-plugin, markdown-it, markdown |

## Links

- npm: https://www.npmjs.com/package/markdown-it-special-terms
- Repository: https://github.com/Nevenall/markdown-it-special-terms
- Issues: https://github.com/Nevenall/markdown-it-special-terms/issues
- npm.io page: https://npm.io/package/markdown-it-special-terms

## 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) — 2018-06-13
- 1.1.0 — 2018-04-29
- 1.0.0 — 2018-01-29

## README

# Special Terms Plugin

  Have a word or phrase in your markdown you'd like to wrap with custom styling?

  This Markdown-it plugin allows you provide custom html for text wrapped in {curly braces}.
  
  The default html is a `<span class="special-term-1">` element.

## Usage

``` javascript
var MarkdownIt = require('markdown-it');
var specialterms = require('markdown-it-special-terms')

var md = new MarkdownIt();

md.use(specialterms);

md.render(`# This is a header containing a {special term}

{Level 1 Special Term}

{{Level 2 Special Term}}

{{{Level 3 Special Term}}}`);

```

renders as:

``` html
<h1>This is a header containing a <span class='special-term-1'>special term</span></h1>
<p><span class='special-term-1'>Level 1 Special Term</span></p>
<p><span class='special-term-2'>Level 2 Special Term</span></p>
<p><span class='special-term-3'>Level 3 Special Term</span></p>
```

## Options

The options object allows you to specify custom opening and closing tags. 

``` javascript
md.use(specialterms, {
   open_1: "<span class='game-term'>",
   close_1: "</span>",
   open_2: "<aside class='callout'>",
   close_2: "</aside>",
   open_3: "<div class='stat-block'>",
   close_3: "</div>"
});
```

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