@types/remark-prism NPM

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

// Type definitions for remark-prism 1.3
// Project: https://github.com/sergioramos/remark-prism#readme
// Definitions by: Hojun Bun <https://github.com/bunhojun>
//                 Stephen Weiss <https://github.com/stephencweiss>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 4.0

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

declare namespace remarkPrism {
    /**
     * Plugin to use prism with remark.
     * https://github.com/unifiedjs/unified/blob/main/index.d.ts#L488-L489
     */
    type Prism = (settings?: Options) => void;
    interface Options {
        transformInlineCode?: boolean;
        plugins?: SupportedPlugins[];
    }
}

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