# @types/remark-prism

> TypeScript definitions for remark-prism

Latest version **1.3.7** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/remark-prism
pnpm add @types/remark-prism
yarn add @types/remark-prism
bun add @types/remark-prism
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.3.7 |
| Published | 2023-11-07 |
| First published | 2021-08-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/remark-prism
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/remark-prism
- npm.io page: https://npm.io/package/@types/remark-prism

## Dependencies (3)

- [remark](https://npm.io/package/remark.md) ^14.0.2
- [unified](https://npm.io/package/unified.md) ^10.0.0
- [@types/mdast](https://npm.io/package/@types/mdast.md) *

## Recent versions

- 1.3.7 (latest) — 2023-11-07
- 1.3.4 (ts4.1) — 2022-11-28
- 1.3.3 (ts4.0) — 2022-04-23
- 1.3.6 — 2023-10-18
- 1.3.5 — 2023-09-27
- 1.3.2 — 2022-04-16
- 1.3.1 — 2022-04-09
- 1.3.0 — 2021-08-07

## README

# Installation
> `npm install --save @types/remark-prism`

# Summary
This package contains type definitions for remark-prism (https://github.com/sergioramos/remark-prism#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/remark-prism.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/remark-prism/index.d.ts)
````ts
import { Root } from "mdast";
import { Plugin } from "unified";

type SupportedPlugins =
    | "autolinker"
    | "command-line"
    | "data-uri-highlight"
    | "diff-highlight"
    | "inline-color"
    | "keep-markup"
    | "line-numbers"
    | "show-invisibles"
    | "treeview";

declare namespace remarkPrism {
    interface Options {
        transformInlineCode?: boolean;
        plugins?: SupportedPlugins[];
    }

    /**
     * Plugin to use prism with remark.
     * https://github.com/unifiedjs/unified/blob/main/index.d.ts#L488-L489
     */
    type Prism = Plugin<[Options?] | undefined[], Root, Root>;
}

declare const remarkPrism: remarkPrism.Prism;
export = remarkPrism;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/mdast](https://npmjs.com/package/@types/mdast), [remark](https://npmjs.com/package/remark), [unified](https://npmjs.com/package/unified)

# Credits
These definitions were written by [Hojun Bun](https://github.com/bunhojun), and [Stephen Weiss](https://github.com/stephencweiss).

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