UNPKG

1.67 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/markdown-it-container`
3
4# Summary
5This package contains type definitions for MarkdownItContainer (markdown-it-container) (https://github.com/markdown-it/markdown-it-container).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/markdown-it-container.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/markdown-it-container/index.d.ts)
10````ts
11// Type definitions for MarkdownItContainer (markdown-it-container) 2.0
12// Project: https://github.com/markdown-it/markdown-it-container
13// Definitions by: Vyacheslav Demot <https://github.com/hronex>
14// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
15// TypeScript Version: 2.3
16
17import MarkdownIt = require('markdown-it');
18import Renderer = require('markdown-it/lib/renderer');
19import Token = require('markdown-it/lib/token');
20
21declare namespace markdownItContainer {
22 interface ContainerOpts {
23 marker?: string | undefined;
24 validate?(params: string): boolean;
25 render?(tokens: Token[], index: number, options: any, env: any, self: Renderer): string;
26 }
27
28 function container_plugin(md: MarkdownIt, name: string, opts: ContainerOpts): void;
29}
30
31declare var MarkdownItContainer: typeof markdownItContainer.container_plugin;
32export = MarkdownItContainer;
33
34````
35
36### Additional Details
37 * Last updated: Fri, 21 Jan 2022 17:01:37 GMT
38 * Dependencies: [@types/markdown-it](https://npmjs.com/package/@types/markdown-it)
39 * Global values: none
40
41# Credits
42These definitions were written by [Vyacheslav Demot](https://github.com/hronex).
43
\No newline at end of file